com.aquenos.epics.jackie.common.protocol

Class ChannelAccessWriteNotifyServerMessage

java.lang.Object

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

com.aquenos.epics.jackie.common.protocol.ChannelAccessWriteNotifyMessage

com.aquenos.epics.jackie.common.protocol.ChannelAccessWriteNotifyServerMessage

public final class ChannelAccessWriteNotifyServerMessage
extends ChannelAccessWriteNotifyMessage

Representation of a CA_PROTO_WRITE_NOTIFY message that is sent from a server to a client. This message is sent in response to a ChannelAccessWriteNotifyClientMessage in order to notify the client that the write operation has finished.

Author:

Sebastian Marsching

See Also:

ChannelAccessCommand.CA_PROTO_WRITE_NOTIFY, ChannelAccessWriteNotifyMessage, ChannelAccessWriteNotifyClientMessage

Field Summary

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

command, originalMessageHeader

Constructor Summary

Constructors

Constructor and Description
ChannelAccessWriteNotifyServerMessage(ChannelAccessValueType dataType, int count, ChannelAccessStatus status, int operationId) Creates a CA_PROTO_WRITE_NOTIFY message.

Method Summary

Modifier and Type	Method and Description
protected static ChannelAccessWriteNotifyServerMessage	deserialize(ChannelAccessMessageHeader messageHeader, ByteSource byteSource) 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	getCount() Returns the number of value elements that were sent with the client's write request.
ChannelAccessValueType	getDataType() Returns the data-type that was sent with the client's write request or null if the data-type number could not be converted because it is unknown to this implementation.
int	getOperationId() Returns the client-assigned operation ID.
ChannelAccessStatus	getStatus() Returns the status of the write operation.
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

ChannelAccessWriteNotifyServerMessage

public ChannelAccessWriteNotifyServerMessage(ChannelAccessValueType dataType,
                                             int count,
                                             ChannelAccessStatus status,
                                             int operationId)

Creates a CA_PROTO_WRITE_NOTIFY message. This constructor should be used to create a message that is supposed to be sent from a server to a client.

Parameters:

dataType - data type sent with the client's write request (never null).

count - count sent with the client's request.

status - status code for the write operation (never null). If the write was successful, the ECA_NORMAL code should be sent. If an error occurred, the respective error code should be sent.

operationId - client-assigned ID identifying the write request. This must be the ID sent with the write request so that the client can identify the request to which the reply belongs.

Method Detail

getDataType

public ChannelAccessValueType getDataType()

Returns the data-type that was sent with the client's write request or null if the data-type number could not be converted because it is unknown to this implementation.

Returns:

data-type specified in the write request or null if the numeric identifier cannot be mapped to a data type known by this implementation.

getCount

public int getCount()

Returns the number of value elements that were sent with the client's write request.

Returns:

number of value elements specified in the write request.

getStatus

public ChannelAccessStatus getStatus()

Returns the status of the write operation. If the write was successful, the status should be ChannelAccessStatus.StatusMessage.ECA_NORMAL . If the write failed, the status should be the appropriate error code.

Returns:

status code of the write operation. Should be ECA_NORMAL for a successful write and the error code for an error.

getOperationId

public int getOperationId()

Returns the client-assigned operation ID. The operation ID is used by the client in order to map replies sent in response to a write request to the respective request. This must always be the ID that was sent by the client. This number might be negative or zero.

Returns:

client-assigned operation identifier.

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

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.

deserialize

protected static ChannelAccessWriteNotifyServerMessage 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).

Throws:

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