1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright 2014-2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.store.cluster.messaging;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Objects;
import org.onlab.util.ByteArraySizeHashPrinter;
import org.onosproject.cluster.NodeId;
import com.google.common.base.Charsets;
import com.google.common.base.MoreObjects;
// TODO: Should payload type be ByteBuffer?
/**
* Base message for cluster-wide communications.
*/
public class ClusterMessage {
private final NodeId sender;
private final MessageSubject subject;
private final byte[] payload;
private transient byte[] response;
/**
* Creates a cluster message.
*
* @param sender message sender
* @param subject message subject
* @param payload message payload
*/
public ClusterMessage(NodeId sender, MessageSubject subject, byte[] payload) {
this.sender = sender;
this.subject = subject;
this.payload = payload;
}
/**
* Returns the id of the controller sending this message.
*
* @return message sender id.
*/
public NodeId sender() {
return sender;
}
/**
* Returns the message subject indicator.
*
* @return message subject
*/
public MessageSubject subject() {
return subject;
}
/**
* Returns the message payload.
*
* @return message payload.
*/
public byte[] payload() {
return payload;
}
/**
* Records the response to be sent to the sender.
*
* @param data response payload
*/
public void respond(byte[] data) {
response = data;
}
/**
* Returns the response to be sent to the sender.
*
* @return response bytes
*/
public byte[] response() {
return response;
}
@Override
public String toString() {
return MoreObjects.toStringHelper(getClass())
.add("sender", sender)
.add("subject", subject)
.add("payload", ByteArraySizeHashPrinter.of(payload))
.toString();
}
@Override
public boolean equals(Object o) {
if (!(o instanceof ClusterMessage)) {
return false;
}
ClusterMessage that = (ClusterMessage) o;
return Objects.equals(this.sender, that.sender) &&
Objects.equals(this.subject, that.subject) &&
Arrays.equals(this.payload, that.payload);
}
/**
* Serializes this instance.
* @return bytes
*/
public byte[] getBytes() {
byte[] senderBytes = sender.toString().getBytes(Charsets.UTF_8);
byte[] subjectBytes = subject.value().getBytes(Charsets.UTF_8);
int capacity = 12 + senderBytes.length + subjectBytes.length + payload.length;
ByteBuffer buffer = ByteBuffer.allocate(capacity);
buffer.putInt(senderBytes.length);
buffer.put(senderBytes);
buffer.putInt(subjectBytes.length);
buffer.put(subjectBytes);
buffer.putInt(payload.length);
buffer.put(payload);
return buffer.array();
}
/**
* Decodes a new ClusterMessage from raw bytes.
* @param bytes raw bytes
* @return cluster message
*/
public static ClusterMessage fromBytes(byte[] bytes) {
ByteBuffer buffer = ByteBuffer.wrap(bytes);
byte[] senderBytes = new byte[buffer.getInt()];
buffer.get(senderBytes);
byte[] subjectBytes = new byte[buffer.getInt()];
buffer.get(subjectBytes);
byte[] payloadBytes = new byte[buffer.getInt()];
buffer.get(payloadBytes);
return new ClusterMessage(new NodeId(new String(senderBytes, Charsets.UTF_8)),
new MessageSubject(new String(subjectBytes, Charsets.UTF_8)),
payloadBytes);
}
@Override
public int hashCode() {
return Objects.hash(sender, subject, payload);
}
}
|
