tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 1 | package org.onlab.onos.store.cluster.messaging; |
| 2 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 3 | import java.io.IOException; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 4 | import java.util.Set; |
| 5 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 6 | import org.onlab.onos.cluster.NodeId; |
| 7 | |
Yuta HIGUCHI | 6e50173 | 2014-10-12 12:00:27 -0700 | [diff] [blame] | 8 | // TODO: remove IOExceptions? |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 9 | /** |
| 10 | * Service for assisting communications between controller cluster nodes. |
| 11 | */ |
| 12 | public interface ClusterCommunicationService { |
| 13 | |
| 14 | /** |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 15 | * Broadcast a message to all controller nodes. |
tom | d33e640 | 2014-09-30 03:14:43 -0700 | [diff] [blame] | 16 | * |
| 17 | * @param message message to send |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 18 | * @return true if the message was sent successfully to all nodes; false otherwise. |
tom | d33e640 | 2014-09-30 03:14:43 -0700 | [diff] [blame] | 19 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 20 | boolean broadcast(ClusterMessage message) throws IOException; |
tom | d33e640 | 2014-09-30 03:14:43 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 23 | * Sends a message to the specified controller node. |
| 24 | * |
| 25 | * @param message message to send |
| 26 | * @param toNodeId node identifier |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 27 | * @return true if the message was sent successfully; false otherwise. |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 28 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 29 | boolean unicast(ClusterMessage message, NodeId toNodeId) throws IOException; |
| 30 | |
| 31 | /** |
| 32 | * Multicast a message to a set of controller nodes. |
| 33 | * |
| 34 | * @param message message to send |
| 35 | * @return true if the message was sent successfully to all nodes in the group; false otherwise. |
| 36 | */ |
| 37 | boolean multicast(ClusterMessage message, Set<NodeId> nodeIds) throws IOException; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 38 | |
| 39 | /** |
| 40 | * Adds a new subscriber for the specified message subject. |
| 41 | * |
| 42 | * @param subject message subject |
| 43 | * @param subscriber message subscriber |
| 44 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 45 | void addSubscriber(MessageSubject subject, ClusterMessageHandler subscriber); |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 46 | } |