org.onosproject.store.cluster.messaging

Interface ClusterCommunicationService

public interface ClusterCommunicationService

Service for assisting communications between controller cluster nodes.

Method Summary

Modifier and Type	Method and Description
void	addSubscriber(MessageSubject subject, ClusterMessageHandler subscriber) Adds a new subscriber for the specified message subject.
boolean	broadcast(ClusterMessage message) Broadcast a message to all controller nodes.
boolean	broadcastIncludeSelf(ClusterMessage message) Broadcast a message to all controller nodes including self.
boolean	multicast(ClusterMessage message, Set<NodeId> nodeIds) Multicast a message to a set of controller nodes.
void	removeSubscriber(MessageSubject subject) Removes a subscriber for the specified message subject.
com.google.common.util.concurrent.ListenableFuture<byte[]>	sendAndReceive(ClusterMessage message, NodeId toNodeId) Sends a message synchronously.
boolean	unicast(ClusterMessage message, NodeId toNodeId) Sends a message to the specified controller node.

Method Detail

broadcast

boolean broadcast(ClusterMessage message)
           throws IOException

Broadcast a message to all controller nodes.

Parameters:

message - message to send

Returns:

true if the message was sent successfully to all nodes; false otherwise.

Throws:

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

broadcastIncludeSelf

boolean broadcastIncludeSelf(ClusterMessage message)
                      throws IOException

Broadcast a message to all controller nodes including self.

Parameters:

message - message to send

Returns:

true if the message was sent successfully to all nodes; false otherwise.

Throws:

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

unicast

boolean unicast(ClusterMessage message,
                NodeId toNodeId)
         throws IOException

Sends a message to the specified controller node.

Parameters:

message - message to send

toNodeId - node identifier

Returns:

true if the message was sent successfully; false otherwise.

Throws:

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

multicast

boolean multicast(ClusterMessage message,
                  Set<NodeId> nodeIds)
           throws IOException

Multicast a message to a set of controller nodes.

Parameters:

message - message to send

nodeIds - recipient node identifiers

Returns:

true if the message was sent successfully to all nodes in the group; false otherwise.

Throws:

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

sendAndReceive

com.google.common.util.concurrent.ListenableFuture<byte[]> sendAndReceive(ClusterMessage message,
                                                                          NodeId toNodeId)
                                                                   throws IOException

Sends a message synchronously.

Parameters:

message - message to send

toNodeId - recipient node identifier

Returns:

reply future.

Throws:

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

addSubscriber

void addSubscriber(MessageSubject subject,
                   ClusterMessageHandler subscriber)

Adds a new subscriber for the specified message subject.

Parameters:

subject - message subject

subscriber - message subscriber

removeSubscriber

void removeSubscriber(MessageSubject subject)

Removes a subscriber for the specified message subject.

Parameters:

subject - message subject