com.aquenos.epics.jackie.common.protocol

Class ChannelAccessRepeaterRegisterMessage

java.lang.Object

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

com.aquenos.epics.jackie.common.protocol.ChannelAccessRepeaterRegisterMessage

public final class ChannelAccessRepeaterRegisterMessage
extends ChannelAccessMessage

Representation of a REPEATER_REGISTER message. This message can only be received, not sent. It is only supported for compatibility with legacy clients. New clients should simply send an empty packet instead. A repeater that receives this message should treat it the same way it treats an empty packet.

Author:

Sebastian Marsching

See Also:

ChannelAccessCommand.REPEATER_REGISTER

Field Summary

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

command, originalMessageHeader

Method Summary

Methods

Modifier and Type	Method and Description
protected static ChannelAccessRepeaterRegisterMessage	deserialize(ChannelAccessMessageHeader messageHeader, ByteSource byteSource) Constructs a message from a header and a byte source.
protected void	serialize(ByteSink byteSink, ChannelAccessVersion version, int maxPayloadSize, Charset charset) Serializes this message to a byte sink.
String	toString() Returns a string representation of this message.
protected void	verify(ChannelAccessVersion version, int maxPayloadSize, Charset charset) Verifies that this message can be serialized.

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

addByteArrayToStringBuilder, calculatePaddingSize, equals, getCommand, getOriginalMessageHeader, hashCode, hasOriginalMessageHeader, serializeHeader, verifyHeader

Methods inherited from class java.lang.Object

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

Method Detail

toString

public 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.

serialize

protected void serialize(ByteSink byteSink,
             ChannelAccessVersion version,
             int maxPayloadSize,
             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).

verify

protected void verify(ChannelAccessVersion version,
          int maxPayloadSize,
          Charset charset)

Description copied from class: ChannelAccessMessage

Verifies that this message can be serialized. This method is only intended to be used by ChannelAccessMessageCodec.

Overrides:

verify in class ChannelAccessMessage

Parameters:

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).

deserialize

protected static ChannelAccessRepeaterRegisterMessage 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 (if headerOnly is false).