com.prosysopc.ua.stack.transport.tcp.nio

Interface InputMessage

All Known Implementing Classes:

SecureInputMessageBuilder

public interface InputMessage

InputMessage interface.

Method Summary

Modifier and Type	Method and Description
Exception	getError() Get error if avaiable.
IEncodeable	getMessage() Get message if available.
int	getMessageType() Get message type.
int	getRequestId() Get request id.
int	getSecureChannelId() Get secure channel Id.
List<Integer>	getSequenceNumbers() Return sequence number of each chunk
Object	getToken() Get security token

Method Detail

getError

Exception getError()

Get error if avaiable.

Returns:

error or null

getMessage

IEncodeable getMessage()

Get message if available. If message is not available, then error is.

Returns:

message or null

getMessageType

int getMessageType()

Get message type. One of the following: TcpMessageType.OPEN Open Channel async message TcpMessageType.CLOSE Close Channel async message TcpMessageType.MESSAGE Service Request, or ErrorMessage

Returns:

message type

getRequestId

int getRequestId()

Get request id. Identifier is secure channel specific.

Returns:

a int.

getSecureChannelId

int getSecureChannelId()

Get secure channel Id. Secure channel is 0 when opening a new secure channel.

Returns:

a int.

getSequenceNumbers

List<Integer> getSequenceNumbers()

Return sequence number of each chunk

Returns:

list of sequence numbers

getToken

Object getToken()

Get security token

Returns:

SecurityConfiguration if async message, SecurityToken is sync message