org.onosproject.store.cluster.messaging

Class ClusterMessage

java.lang.Object

org.onosproject.store.cluster.messaging.ClusterMessage

public class ClusterMessage
extends Object

Base message for cluster-wide communications.

Constructor Summary

Constructors

Constructor and Description
ClusterMessage(NodeId sender, MessageSubject subject, byte[] payload) Creates a cluster message.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ClusterMessage	fromBytes(byte[] bytes) Decodes a new ClusterMessage from raw bytes.
byte[]	getBytes() Serializes this instance.
int	hashCode()
byte[]	payload() Returns the message payload.
void	respond(byte[] data) Records the response to be sent to the sender.
byte[]	response() Returns the response to be sent to the sender.
NodeId	sender() Returns the id of the controller sending this message.
MessageSubject	subject() Returns the message subject indicator.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterMessage

public ClusterMessage(NodeId sender,
                      MessageSubject subject,
                      byte[] payload)

Creates a cluster message.

Parameters:

sender - message sender

subject - message subject

payload - message payload

Method Detail

sender

public NodeId sender()

Returns the id of the controller sending this message.

Returns:

message sender id.

subject

public MessageSubject subject()

Returns the message subject indicator.

Returns:

message subject

payload

public byte[] payload()

Returns the message payload.

Returns:

message payload.

respond

public void respond(byte[] data)

Records the response to be sent to the sender.

Parameters:

data - response payload

response

public byte[] response()

Returns the response to be sent to the sender.

Returns:

response bytes

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getBytes

public byte[] getBytes()

Serializes this instance.

Returns:

bytes

fromBytes

public static ClusterMessage fromBytes(byte[] bytes)

Decodes a new ClusterMessage from raw bytes.

Parameters:

bytes - raw bytes

Returns:

cluster message

hashCode

public int hashCode()

Overrides:

hashCode in class Object