com.aquenos.epics.jackie.common.protocol

Class ChannelAccessVersionTCPServerMessage

java.lang.Object

com.aquenos.epics.jackie.common.protocol.ChannelAccessMessage

com.aquenos.epics.jackie.common.protocol.ChannelAccessVersionMessage

com.aquenos.epics.jackie.common.protocol.ChannelAccessVersionTCPServerMessage

public final class ChannelAccessVersionTCPServerMessage
extends ChannelAccessVersionMessage

Representation of a CA_PROTO_VERSION message that is sent from a server to a client via TCP. This message is usually send at the start of a new TCP connection in order to communicate the protocol version supported by the server.

Author:

Sebastian Marsching

See Also:

ChannelAccessCommand.CA_PROTO_VERSION, ChannelAccessVersionUDPMessage, ChannelAccessVersionTCPClientMessage

Field Summary

Fields inherited from class com.aquenos.epics.jackie.common.protocol.ChannelAccessVersionMessage

version

Fields inherited from class com.aquenos.epics.jackie.common.protocol.ChannelAccessMessage

command, originalMessageHeader

Constructor Summary

Constructors

Constructor and Description
ChannelAccessVersionTCPServerMessage(ChannelAccessVersion version) Creates a CA_PROTO_VERSION message.

Method Summary

Modifier and Type	Method and Description
protected static ChannelAccessVersionTCPServerMessage	deserialize(ChannelAccessMessageHeader messageHeader, ByteSource byteSource) Constructs a message from a header and a byte source.
protected void	serialize(ByteSink byteSink, ChannelAccessVersion version, int maxPayloadSize, java.nio.charset.Charset charset) Serializes this message to a byte sink.
java.lang.String	toString() Returns a string representation of this message.

Methods inherited from class com.aquenos.epics.jackie.common.protocol.ChannelAccessVersionMessage

equals, getVersion, hashCode

Methods inherited from class com.aquenos.epics.jackie.common.protocol.ChannelAccessMessage

addByteArrayToStringBuilder, calculatePaddingSize, getCommand, getOriginalMessageHeader, hasOriginalMessageHeader, serializeHeader, verify, verifyHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelAccessVersionTCPServerMessage

public ChannelAccessVersionTCPServerMessage(ChannelAccessVersion version)

Creates a CA_PROTO_VERSION message. This constructor should be used to create a message that is supposed to be sent from a server to a client using the TCP protocol.

Parameters:

version - Channel Access version supported by the server.

Method Detail

serialize

protected void serialize(ByteSink byteSink,
                         ChannelAccessVersion version,
                         int maxPayloadSize,
                         java.nio.charset.Charset charset)

Description copied from class: ChannelAccessMessage

Serializes this message to a byte sink. This method is only intended to be used by ChannelAccessMessageCodec.

Specified by:

serialize in class ChannelAccessMessage

Parameters:

byteSink - byte sink that is used for writing the serialized data.

version - protocol version to stay compatible with. This is the protocol version of the peer the message is sent to.

maxPayloadSize - maximum size of the payload.

charset - encoding to use for serializing the string data (e.g. channel names, error strings, string data-values).

toString

public java.lang.String toString()

Description copied from class: ChannelAccessMessage

Returns a string representation of this message. The string representation contains the messages command, its header fields (if relevant for the command type) and its payload if present.

Overrides:

toString in class ChannelAccessMessage

Returns:

string representation of this message.

deserialize

protected static ChannelAccessVersionTCPServerMessage deserialize(ChannelAccessMessageHeader messageHeader,
                                                                  ByteSource byteSource)

Constructs a message from a header and a byte source. This method is only intended for use by ChannelAccessMessageCodec.

Parameters:

messageHeader - CA message header.

byteSource - byte source for reading the message's payload (if any).

Returns:

message constructed from the data in the header and the payload read from the byte source.

Throws:

java.nio.BufferUnderflowException - if there is not enough data in the byte source to read the complete payload.