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
byte[]	payload() Returns the message payload.
void	respond(byte[] data) Sends a response 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, equals, finalize, getClass, hashCode, 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)
             throws IOException

Sends a response to the sender.

Parameters:

data - payload response.

Throws:

IOException - when I/O exception of some sort has occurred

toString

public String toString()

Overrides:

toString in class Object