com.aquenos.epics.jackie.common.protocol

Class ChannelAccessSearchUDPServerMessage

java.lang.Object

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

com.aquenos.epics.jackie.common.protocol.ChannelAccessSearchMessage

com.aquenos.epics.jackie.common.protocol.ChannelAccessSearchUDPServerMessage

public final class ChannelAccessSearchUDPServerMessage
extends ChannelAccessSearchMessage

Representation of a CA_PROTO_SEARCH message that is sent from a server to a client via UDP in reply to a ChannelAccessSearchClientMessage. This message carries information about how to connect to the requested channel.

Author:

Sebastian Marsching

See Also:

ChannelAccessCommand.CA_PROTO_SEARCH

Field Summary

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

command, originalMessageHeader

Constructor Summary

Constructors

Constructor and Description
ChannelAccessSearchUDPServerMessage(ChannelAccessVersion version, int cid, java.net.Inet4Address serverAddress, int serverPort) Creates a CA_PROTO_SEARCH message that can be sent from a server to a client via UDP.

Method Summary

Modifier and Type	Method and Description
protected static ChannelAccessSearchUDPServerMessage	deserialize(ChannelAccessMessageHeader messageHeader, ByteSource byteSource, java.net.Inet4Address originatingServerAddress, int originatingServerPort) Constructs a message from a header and a byte source.
boolean	equals(java.lang.Object obj) Tells whether the specified object represents the same message.
int	getChannelCID() Returns the channel ID that is used by the client to identify the channel.
java.net.Inet4Address	getServerAddress() Returns the IP address of the server that is serving the requested channel.
int	getServerPort() Returns the TCP port number on which the server that is serving the requested channel is listening.
ChannelAccessVersion	getVersion() Returns the Channel Access version supported by this server.
int	hashCode() Returns a hash code value for this message.
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.
protected void	verify(ChannelAccessVersion version, int maxPayloadSize, java.nio.charset.Charset charset) Verifies that this message can be serialized.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelAccessSearchUDPServerMessage

public ChannelAccessSearchUDPServerMessage(ChannelAccessVersion version,
                                           int cid,
                                           java.net.Inet4Address serverAddress,
                                           int serverPort)

Creates a CA_PROTO_SEARCH message that can be sent from a server to a client via UDP.

Parameters:

version - Channel Access protocol version supported by this server (or the server that is serving the channel).

cid - client-side channel identifier. This is the identifier that has been sent by the client with the search request and is used by the client to map the response to the right channel.

serverAddress - IP address of the server serving the channel. If this is null or the wildcard address, the client will try to connect to the server sending this message.

serverPort - TCP port of the server serving the channel. For messages using a protocol version older than Channel Access version 4.5, the port is not sent with the message and the originating port of the UDP message is used instead.

Method Detail

getChannelCID

public int getChannelCID()

Returns the channel ID that is used by the client to identify the channel. This integer may be zero or negative.

Returns:

client-side ID for the channel.

getServerAddress

public java.net.Inet4Address getServerAddress()

Returns the IP address of the server that is serving the requested channel.

Returns:

IP address of the server for the channel.

getServerPort

public int getServerPort()

Returns the TCP port number on which the server that is serving the requested channel is listening.

Returns:

TCP port number.

getVersion

public ChannelAccessVersion getVersion()

Returns the Channel Access version supported by this server. A client can use this information in order to decide which features it can use when connecting to the channel.

Returns:

Channel Access version supported by the server.

equals

public boolean equals(java.lang.Object obj)

Description copied from class: ChannelAccessMessage

Tells whether the specified object represents the same message.

Two messages are considered equal if they are of the same type and have the same headers and payload. For comparing the types, the actual Java type and not just the Channel Access command is compared.

Overrides:

equals in class ChannelAccessMessage

Parameters:

obj - reference object with which this object is compared.

Returns:

true if obj is a message that is of the same type and has the same headers and payload as this message. false if obj is null or of a different type than this message or differs in the headers or payload.

hashCode

public int hashCode()

Description copied from class: ChannelAccessMessage

Returns a hash code value for this message. This method is supported for the benefit of hash tables. The hash code is calculated as a combination of the hash codes of this messages headers (including the Channel Access command) and its payload (if present).

If two messages are equal (as indicated by the return value of ChannelAccessMessage.equals(Object)), they also have the same hash code. However, the fact that two messages have the same hash code does not imply that they are equal.

Overrides:

hashCode in class ChannelAccessMessage

Returns:

hash code suitable for use by a hash table.

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.

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

verify

protected void verify(ChannelAccessVersion version,
                      int maxPayloadSize,
                      java.nio.charset.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 ChannelAccessSearchUDPServerMessage deserialize(ChannelAccessMessageHeader messageHeader,
                                                                 ByteSource byteSource,
                                                                 java.net.Inet4Address originatingServerAddress,
                                                                 int originatingServerPort)

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

originatingServerAddress - IP address of the server that sent this message.

originatingServerPort - UDP port of the server that sent this message.

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.