tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 1 | package org.onlab.onos.store.cluster.messaging; |
| 2 | |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame^] | 3 | import java.io.IOException; |
| 4 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 5 | import org.onlab.onos.cluster.NodeId; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 6 | |
Yuta HIGUCHI | 971addc | 2014-10-07 23:23:17 -0700 | [diff] [blame] | 7 | // TODO: Should payload type be ByteBuffer? |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 8 | /** |
| 9 | * Base message for cluster-wide communications. |
| 10 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 11 | public class ClusterMessage { |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 12 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 13 | private final NodeId sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 14 | private final MessageSubject subject; |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 15 | private final byte[] payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 16 | |
| 17 | /** |
| 18 | * Creates a cluster message. |
| 19 | * |
| 20 | * @param subject message subject |
| 21 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 22 | public ClusterMessage(NodeId sender, MessageSubject subject, byte[] payload) { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 23 | this.sender = sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 24 | this.subject = subject; |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 25 | this.payload = payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 26 | } |
| 27 | |
| 28 | /** |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 29 | * Returns the id of the controller sending this message. |
| 30 | * |
| 31 | * @return message sender id. |
| 32 | */ |
| 33 | public NodeId sender() { |
| 34 | return sender; |
| 35 | } |
| 36 | |
| 37 | /** |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 38 | * Returns the message subject indicator. |
| 39 | * |
| 40 | * @return message subject |
| 41 | */ |
| 42 | public MessageSubject subject() { |
| 43 | return subject; |
| 44 | } |
| 45 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 46 | /** |
| 47 | * Returns the message payload. |
| 48 | * |
| 49 | * @return message payload. |
| 50 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 51 | public byte[] payload() { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 52 | return payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 53 | } |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame^] | 54 | |
| 55 | /** |
| 56 | * Sends a response to the sender. |
| 57 | * |
| 58 | * @param data payload response. |
| 59 | * @throws IOException |
| 60 | */ |
| 61 | public void respond(byte[] data) throws IOException { |
| 62 | throw new IllegalStateException("One can only repond to message recived from others."); |
| 63 | } |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 64 | } |