TcpConnection (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.stack.transport.tcp.io.TcpConnection

All Implemented Interfaces:

IConnection
```
public class TcpConnection
extends Object
implements IConnection
```
This class implements OPC UA Secure Conversation (UASC) for client to server communication.
OPC UA TCP is a simple TCP based protocol that establishes a full duplex channel between a client and server. This protocol has two key features that differentiate it from HTTP. First, this protocol allows responses to be returned in any order. Second, this protocol allows responses to be returned on a different socket if communication failures causes temporary socket interruption. The OPC UA TCP protocol is designed to work with the SecureChannel implemented by a layer higher in the stack. For this reason, the OPC UA TCP protocol defines its interactions with the SecureChannel in addition to the wire protocol.
Features included in this class: o Establishing connection, Handshake o Sync and Async encryption Features excluded in this class: o Reconnect (See SecureChannel) o Token Renewal (See SecureChannel) TcpConnection is instantiated and managed by SecureChannel which also handles Reconnection and token renewal.
OpenSecureChannelRequest and OpenSecureChannelResponse is ciphered with asymmetric encryption using the certificates set in initialize. Asymmetric encryption is omited if server certificate is null. (This is not allowed in Part 4, but is in Part 6). DiscoveryClient uses unencrypted connection. TcpConnection captures security tokens from OpenSecureChannel conversation and uses them for symmetric messaging. The oldest non-expired token is used.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TcpConnection.DefaultExecutorProvider` The default implementation, which always returns StackUtils.getBlockingWorkExecutor().
`static class`	`TcpConnection.DefaultReverseConnectionProvider` The `TcpConnection.ReverseConnectionProvider` that `TcpConnection` uses by default.
`static class`	`TcpConnection.DefaultSocketFactory` The `TcpConnection.SocketFactory` that `TcpConnection` uses by default.
`static class`	`TcpConnection.DelegatingSocketWrapper` Simple implementation of `TcpConnection.SocketWrapper` that delegates the all calls to the given Socket.
`static interface`	`TcpConnection.ExecutorProvider` Provides an Executor to be used for message decoding and potential other tasks.
`static interface`	`TcpConnection.ReverseConnectionProvider` Provides "ReverseHello" socket connections for `TcpConnection`.
`static interface`	`TcpConnection.SocketFactory` Allows implementing custom `TcpConnection.SocketWrapper` implementations to allow usage of custom `Socket`s (or anything that can be abstracted as input output stream).
`static interface`	`TcpConnection.SocketWrapper` A wrapper for a `Socket` or anything that can be made to same abstraction.

Nested classes/interfaces inherited from interface com.prosysopc.ua.stack.transport.tcp.io.IConnection
IConnection.IMessageListener

Constructor Summary

Constructors
Constructor and Description

TcpConnection()

Constructors
Constructor and Description
`TcpConnection()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnectionListener(IConnectionListener listener)` Add response listener
`void`	`addMessageListener(IConnection.IMessageListener listener)` Add input stream message listener.
`void`	`close()` Close the socket connection.
`void`	`dispose()` Optional dispose closes connection and clears all variables
`static int`	`getDefaultHandshakeTimeout()` See `setDefaultHandshakeTimeout(int)`
`static int`	`getDefaultReverseHelloAcceptTimeout()` See `setDefaultReverseHelloAcceptTimeout(int)`
`EndpointConfiguration`	`getEndpointConfiguration()` Getter for the field `endpointConfiguration`.
`EndpointDescription`	`getEndpointDescription()` Getter for the field `endpointDescription`.
`static TcpConnection.ExecutorProvider`	`getExecutorProvider()` Returns the current `TcpConnection.ExecutorProvider` used for all connections.
`int`	`getHandshakeTimeout()` Getter for the field `handshakeTimeout`.
`EncoderContext`	`getMessageContext()` getMessageContext.
`int`	`getProtocolVersion()` Get the protocol version agreen in the hand-shake
`static int`	`getReceiveBufferSize()` Getter for the field `receiveBufferSize`.
`static TcpConnection.ReverseConnectionProvider`	`getReverseConnectionProvider()` Returns the current `TcpConnection.ReverseConnectionProvider` implementation in use.
`int`	`getReverseHelloAcceptTimeout()` See `setDefaultReverseHelloAcceptTimeout(int)`.
`static int`	`getSendBufferSize()` Getter for the field `sendBufferSize`.
`protected TcpConnection.SocketWrapper`	`getSocket()` Getter for the field `socket`.
`SocketAddress`	`getSocketAddress()` Get the initialized socket address
`static TcpConnection.SocketFactory`	`getSocketFactory()` Returns the current `TcpConnection.SocketFactory` implementation in use.
`void`	`initialize(InetSocketAddress addr, TransportChannelSettings settings, EncoderContext ctx)` Set connection configuration parameters.
`void`	`initialize(String url, TransportChannelSettings settings, EncoderContext ctx)`
`void`	`initialize(TransportChannelSettings settings, EncoderContext ctx)` initialize.
`void`	`open()` open.
`void`	`reconnect()` reconnect.
`void`	`removeConnectionListener(IConnectionListener listener)` Add response listener
`void`	`removeMessageListener(IConnection.IMessageListener listener)` removeMessageListener.
`void`	`sendRequest(ServiceRequest request, int secureChannelId, int requestId)` Send request to the connection.
`static void`	`setDefaultHandshakeTimeout(int defaultHandshakeTimeout)` Set the default timeout (in milliseconds) for making the initial connection handshake.
`static void`	`setDefaultReverseHelloAcceptTimeout(int defaultReverseHelloAcceptTimeout)` Set the default timeout used for accepting incoming ReverseHello connections.
`static void`	`setExecutorProvider(TcpConnection.ExecutorProvider executorProvider)` Sets an `TcpConnection.ExecutorProvider` that will be used for all connections.
`void`	`setHandshakeTimeout(int handshakeTimeout)` Setter for the field `handshakeTimeout`.
`static void`	`setReceiveBufferSize(int receiveBufferSize)` Define the receiveBufferSize to use for the connection socket.
`static void`	`setReverseConnectionProvider(TcpConnection.ReverseConnectionProvider reverseConnectionProvider)` Set a custom `TcpConnection.ReverseConnectionProvider` which is used to make sockets in reverse connections.
`void`	`setReverseHelloAcceptTimeout(int reverseHelloAcceptTimeout)` See `setDefaultReverseHelloAcceptTimeout(int)`.
`static void`	`setSendBufferSize(int sendBufferSize)` Define the sendBufferSize to use for the connection socket.
`protected void`	`setSocket(TcpConnection.SocketWrapper socket)` Setter for the field `socket`.
`static void`	`setSocketFactory(TcpConnection.SocketFactory newSocketFactory)` Set a `TcpConnection.SocketFactory` to be used to generate the underlying sockets.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TcpConnection
```
public TcpConnection()
```
- Method Detail
  - getDefaultHandshakeTimeout
```
public static int getDefaultHandshakeTimeout()
```
    See setDefaultHandshakeTimeout(int)
  - getDefaultReverseHelloAcceptTimeout
```
public static int getDefaultReverseHelloAcceptTimeout()
```
    See setDefaultReverseHelloAcceptTimeout(int)
  - getExecutorProvider
```
public static TcpConnection.ExecutorProvider getExecutorProvider()
```
    Returns the current TcpConnection.ExecutorProvider used for all connections.
  - getReceiveBufferSize
```
public static int getReceiveBufferSize()
```
    Getter for the field receiveBufferSize.
    
    Returns:
    
    the receiveBufferSize to use for the connection socket.
  - getReverseConnectionProvider
```
public static TcpConnection.ReverseConnectionProvider getReverseConnectionProvider()
```
    Returns the current TcpConnection.ReverseConnectionProvider implementation in use.
  - getSendBufferSize
```
public static int getSendBufferSize()
```
    Getter for the field sendBufferSize.
    
    Returns:
    
    the sendBufferSize to use for the connection socket.
  - getSocketFactory
```
public static TcpConnection.SocketFactory getSocketFactory()
```
    Returns the current TcpConnection.SocketFactory implementation in use.
  - setDefaultHandshakeTimeout
```
public static void setDefaultHandshakeTimeout(int defaultHandshakeTimeout)
```
    Set the default timeout (in milliseconds) for making the initial connection handshake. Default value is 60000. It should be noted that the actual value used by the Operating System can be lower, usually the max timeout is around 20 seconds.
  - setDefaultReverseHelloAcceptTimeout
```
public static void setDefaultReverseHelloAcceptTimeout(int defaultReverseHelloAcceptTimeout)
```
    Set the default timeout used for accepting incoming ReverseHello connections. NOTE! This is used to timeout ServerSocket.accept(). The timeout for receiving a ReverseHello from the Server after a connection is accepted is determined by getDefaultHandshakeTimeout(). Parameter is in milliseconds. Default value is 0, meaning infinite wait.
  - setExecutorProvider
```
public static void setExecutorProvider(TcpConnection.ExecutorProvider executorProvider)
```
    Sets an TcpConnection.ExecutorProvider that will be used for all connections. By default uses TcpConnection.DefaultExecutorProvider, which uses the StackUtils.getBlockingWorkExecutor(). Important! The returned Executor is used for message decoding. By default message decoding can resolve unknown Structures i.e. will do service calls. If that feature is enabled, the returned Executor must/shall exec the Runnables in another thread (i.e. returning an executor that uses the current thread can lead to problems). Additionally there should be preferably be a number of threads backed by the Executor, otherwise there might be performance hits.
  - setReceiveBufferSize
```
public static void setReceiveBufferSize(int receiveBufferSize)
```
    Define the receiveBufferSize to use for the connection socket. You must define the value before the client is connected. The value is applied to the underlying socket, right the socket is created.
    Default value: 0, which omits the parameter and the default value for the socket (depending on the operating system) is used.
    
    Parameters:
    
    receiveBufferSize - the new size in bytes
    
    See Also:
    
    "http://fasterdata.es.net/host-tuning/background/"
  - setReverseConnectionProvider
```
public static void setReverseConnectionProvider(TcpConnection.ReverseConnectionProvider reverseConnectionProvider)
```
    Set a custom TcpConnection.ReverseConnectionProvider which is used to make sockets in reverse connections.
  - setSendBufferSize
```
public static void setSendBufferSize(int sendBufferSize)
```
    Define the sendBufferSize to use for the connection socket. You must define the value before the client is connected. The value is applied to the underlying socket, right the socket is created.
    Default value: 0, which omits the parameter and the default value for the socket (depending on the operating system) is used.
    
    Parameters:
    
    sendBufferSize - the new size in bytes
  - setSocketFactory
```
public static void setSocketFactory(TcpConnection.SocketFactory newSocketFactory)
```
    Set a TcpConnection.SocketFactory to be used to generate the underlying sockets.
  - addConnectionListener
```
public void addConnectionListener(IConnectionListener listener)
```
    Add response listener
    
    Specified by:
    
    addConnectionListener in interface IConnection
    
    Parameters:
    
    listener - a IConnectionListener object.
  - addMessageListener
```
public void addMessageListener(IConnection.IMessageListener listener)
```
    Add input stream message listener. All incoming messages are notified to the listener. The listener may not block in message handling as the message is handled in read thread.
    
    Specified by:
    
    addMessageListener in interface IConnection
    
    Parameters:
    
    listener - message listener
  - close
```
public void close()
```
    Close the socket connection. This method does not request CloseSecureChannel. Does nothing if it is already closed or was never opened. This method is invoked by the user and internally by read thread.
    
    Specified by:
    
    close in interface IConnection
  - dispose
```
public void dispose()
```
    Optional dispose closes connection and clears all variables
    
    Specified by:
    
    dispose in interface IConnection
  - getEndpointConfiguration
```
public EndpointConfiguration getEndpointConfiguration()
```
    Getter for the field endpointConfiguration.
    
    Returns:
    
    a EndpointConfiguration object.
  - getEndpointDescription
```
public EndpointDescription getEndpointDescription()
```
    Getter for the field endpointDescription.
    
    Returns:
    
    a EndpointDescription object.
  - getHandshakeTimeout
```
public int getHandshakeTimeout()
```
    Getter for the field handshakeTimeout.
    
    Returns:
    
    a int.
  - getMessageContext
```
public EncoderContext getMessageContext()
```
    getMessageContext.
    
    Returns:
    
    a EncoderContext object.
  - getProtocolVersion
```
public int getProtocolVersion()
```
    Get the protocol version agreen in the hand-shake
    
    Returns:
    
    connection protocol version
  - getReverseHelloAcceptTimeout
```
public int getReverseHelloAcceptTimeout()
```
    See setDefaultReverseHelloAcceptTimeout(int).
  - getSocketAddress
```
public SocketAddress getSocketAddress()
```
    Get the initialized socket address
    
    Returns:
    
    socket address or null if the connection has not been initialized
  - initialize
```
public void initialize(InetSocketAddress addr,
                       TransportChannelSettings settings,
                       EncoderContext ctx)
                throws ServiceResultException
```
    Set connection configuration parameters.
    
    Specified by:
    
    initialize in interface IConnection
    
    Parameters:
    
    addr - a InetSocketAddress object.
    
    settings - a TransportChannelSettings object.
    
    ctx - a EncoderContext object.
    
    Throws:
    
    ServiceResultException - if any.
  - initialize
```
public void initialize(String url,
                       TransportChannelSettings settings,
                       EncoderContext ctx)
                throws ServiceResultException
```
    Throws:
    
    ServiceResultException
  - initialize
```
public void initialize(TransportChannelSettings settings,
                       EncoderContext ctx)
                throws ServiceResultException
```
    initialize.
    
    Parameters:
    
    settings - a TransportChannelSettings object.
    
    ctx - a EncoderContext object.
    
    Throws:
    
    ServiceResultException - if any.
  - open
```
public void open()
          throws ServiceResultException
```
    open.
    
    Specified by:
    
    open in interface IConnection
    
    Throws:
    
    ServiceResultException - if any.
  - reconnect
```
public void reconnect()
               throws ServiceResultException
```
    reconnect.
    
    Specified by:
    
    reconnect in interface IConnection
    
    Throws:
    
    ServiceResultException - if any.
  - removeConnectionListener
```
public void removeConnectionListener(IConnectionListener listener)
```
    Add response listener
    
    Specified by:
    
    removeConnectionListener in interface IConnection
    
    Parameters:
    
    listener - a IConnectionListener object.
  - removeMessageListener
```
public void removeMessageListener(IConnection.IMessageListener listener)
```
    removeMessageListener.
    
    Specified by:
    
    removeMessageListener in interface IConnection
    
    Parameters:
    
    listener - a IMessageListener object.
  - sendRequest
```
public void sendRequest(ServiceRequest request,
                        int secureChannelId,
                        int requestId)
                 throws ServiceResultException
```
    Send request to the connection. If the connection is closed Bad_NotConnected is thrown Send service request using a given secure channel and operation time out. The operation may be interrupted by interrupting the calling thread with Thread.interrupt().
    
    Specified by:
    
    sendRequest in interface IConnection
    
    secureChannelId - a int.
    
    Throws:
    
    ServiceResultException - varies. Bad_NotConnected if connection is not established
  - setHandshakeTimeout
```
public void setHandshakeTimeout(int handshakeTimeout)
```
    Setter for the field handshakeTimeout.
    
    Parameters:
    
    handshakeTimeout - a int.
  - setReverseHelloAcceptTimeout
```
public void setReverseHelloAcceptTimeout(int reverseHelloAcceptTimeout)
```
    See setDefaultReverseHelloAcceptTimeout(int).
  - getSocket
```
protected TcpConnection.SocketWrapper getSocket()
```
    Getter for the field socket.
    
    Returns:
    
    a Socket object.
  - setSocket
```
protected void setSocket(TcpConnection.SocketWrapper socket)
```
    Setter for the field socket.
    
    Parameters:
    
    socket - the socket to set

Class TcpConnection

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.stack.transport.tcp.io.IConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TcpConnection

Method Detail

getDefaultHandshakeTimeout

getDefaultReverseHelloAcceptTimeout

getExecutorProvider

getReceiveBufferSize

getReverseConnectionProvider

getSendBufferSize

getSocketFactory

setDefaultHandshakeTimeout

setDefaultReverseHelloAcceptTimeout

setExecutorProvider

setReceiveBufferSize

setReverseConnectionProvider

setSendBufferSize

setSocketFactory

addConnectionListener

addMessageListener

close

dispose

getEndpointConfiguration

getEndpointDescription

getHandshakeTimeout

getMessageContext

getProtocolVersion

getReverseHelloAcceptTimeout

getSocketAddress

initialize

initialize

initialize

open

reconnect

removeConnectionListener

removeMessageListener

sendRequest

setHandshakeTimeout

setReverseHelloAcceptTimeout

getSocket

setSocket