public final class ChannelAccessConnectChannelClientMessage extends ChannelAccessConnectChannelMessage
CA_PROTO_CREATE_CHAN
message that is sent
from a client to a server. This message is sent in order to connect to a
channel. Multiple channels can be connected within the same TCP connection.ChannelAccessCommand.CA_PROTO_CREATE_CHAN
,
ChannelAccessConnectChannelServerMessage
,
ChannelAccessConnectChannelFailedMessage
command, originalMessageHeader
Constructor and Description |
---|
ChannelAccessConnectChannelClientMessage(int cid,
ChannelAccessVersion version,
java.lang.String channelName)
Creates a
CA_PROTO_CREATE_CHAN message. |
Modifier and Type | Method and Description |
---|---|
protected static ChannelAccessConnectChannelClientMessage |
deserialize(ChannelAccessMessageHeader messageHeader,
ByteSource byteSource,
boolean headerOnly,
java.nio.charset.Charset charset)
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 CID used by the client.
|
java.lang.String |
getChannelName()
Returns the name of the channel that the client wants to connect to.
|
ChannelAccessVersion |
getVersion()
Returns the Channel Access version supported by this client.
|
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.
|
addByteArrayToStringBuilder, calculatePaddingSize, getCommand, getOriginalMessageHeader, hasOriginalMessageHeader, serializeHeader, verifyHeader
public ChannelAccessConnectChannelClientMessage(int cid, ChannelAccessVersion version, java.lang.String channelName)
CA_PROTO_CREATE_CHAN
message. This constructor
should be used to create a message that is supposed to be sent from a
client to a server.cid
- channel CID used by the client. This is the identifier that
the client will use to identify the channel in the response
from the server. This number might be negative or zero.
However, the value 0xffffffff is reserved for special use and
should be avoided.version
- Channel Access version supported by the client.channelName
- the name of the channel that shall be connected.java.lang.IllegalArgumentException
- if the channelCID
is 0xffffffff.public int getChannelCID()
public ChannelAccessVersion getVersion()
null
).public java.lang.String getChannelName()
null
if this message instance has been reconstructed
without its payload (as part of the payload of an error message).protected void serialize(ByteSink byteSink, ChannelAccessVersion version, int maxPayloadSize, java.nio.charset.Charset charset)
ChannelAccessMessage
ChannelAccessMessageCodec
.serialize
in class ChannelAccessMessage
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).protected void verify(ChannelAccessVersion version, int maxPayloadSize, java.nio.charset.Charset charset)
ChannelAccessMessage
ChannelAccessMessageCodec
.verify
in class ChannelAccessMessage
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).public boolean equals(java.lang.Object obj)
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.
equals
in class ChannelAccessMessage
obj
- reference object with which this object is compared.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.public int hashCode()
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.
hashCode
in class ChannelAccessMessage
public java.lang.String toString()
ChannelAccessMessage
toString
in class ChannelAccessMessage
protected static ChannelAccessConnectChannelClientMessage deserialize(ChannelAccessMessageHeader messageHeader, ByteSource byteSource, boolean headerOnly, java.nio.charset.Charset charset)
ChannelAccessMessageCodec
.messageHeader
- CA message header.byteSource
- byte source for reading the message's payload (if any).headerOnly
- if true
this method will not try to read the
payload but just read the header. This is useful for reading a
message that is sent in the payload of a
ChannelAccessErrorMessage
. Such a message will have
all headers but no payload (even so the payload size might be
non-zero).charset
- encoding to use for deserializing the channel name. Usually,
channel names should consist of ASCII characters only, however
this is not strictly enforced by the protocol, so the encoding
might matter.java.nio.BufferUnderflowException
- if there is not enough data in the byte source to read the
complete payload.InvalidPriorityException
- if the priority specified in the message header is out of
range.Copyright © 2014–2018 aquenos GmbH. All rights reserved.