org.opcfoundation.ua.transport.tcp.io
Interface IConnection

All Known Implementing Classes:
TcpConnection

public interface IConnection

IConnection interface.


Nested Class Summary
static interface IConnection.IMessageListener
          Message listener interface
 
Method Summary
 void addConnectionListener(IConnectionListener listener)
          Add response listener
 void addMessageListener(IConnection.IMessageListener listener)
          Add response listener
 void close()
          Close the connection.
 void dispose()
          Dispose the object making it unusable.
 void initialize(InetSocketAddress addr, TransportChannelSettings settings, EncoderContext ctx)
          Set connection configuration parameters.
 void open()
          Attempt to open the connection.
 void reconnect()
          Open if the connection is not open.
 void removeConnectionListener(IConnectionListener listener)
          Add response listener
 void removeMessageListener(IConnection.IMessageListener listener)
          Add response listener
 void sendRequest(ServiceRequest request, int secureChannelId, int requestId)
          Send request to the connection.
 

Method Detail

initialize

void initialize(InetSocketAddress addr,
                TransportChannelSettings settings,
                EncoderContext ctx)
                throws ServiceResultException
Set connection configuration parameters.

Parameters:
addr - a InetSocketAddress object.
settings - a TransportChannelSettings object.
ctx - a EncoderContext object.
Throws:
ServiceResultException - if any.

sendRequest

void sendRequest(ServiceRequest request,
                 int secureChannelId,
                 int requestId)
                 throws ServiceResultException
Send request to the connection. If the connection is closed Bad_NotConnected is thrown

Parameters:
request -
requestId -
secureChannelId - a int.
requestId - a int.
Throws:
ServiceResultException - varies. Bad_NotConnected if connection is not established

addMessageListener

void addMessageListener(IConnection.IMessageListener listener)
Add response listener

Parameters:
listener - a IConnection.IMessageListener object.

removeMessageListener

void removeMessageListener(IConnection.IMessageListener listener)
Add response listener

Parameters:
listener - a IConnection.IMessageListener object.

addConnectionListener

void addConnectionListener(IConnectionListener listener)
Add response listener

Parameters:
listener - a IConnectionListener object.

removeConnectionListener

void removeConnectionListener(IConnectionListener listener)
Add response listener

Parameters:
listener - a IConnectionListener object.

open

void open()
          throws ServiceResultException
Attempt to open the connection. There is no error if the connection is already open.

Throws:
ServiceResultException - if any.

close

void close()
Close the connection. There is no error if the connection is already closed.


reconnect

void reconnect()
               throws ServiceResultException
Open if the connection is not open.

Throws:
ServiceResultException - if any.

dispose

void dispose()
Dispose the object making it unusable.



Copyright © 2018. All rights reserved.