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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.catalina.tribes;
import java.io.Serializable;
import org.apache.catalina.tribes.io.XByteBuffer;
/**
* Message that is passed through the interceptor stack after the
* data serialized in the Channel object and then passed down to the
* interceptor and eventually down to the ChannelSender component
* @author Filip Hanik
*
*/
public interface ChannelMessage extends Serializable {
/**
* Get the address that this message originated from.
* Almost always <code>Channel.getLocalMember(boolean)</code><br>
* This would be set to a different address
* if the message was being relayed from a host other than the one
* that originally sent it.
* @return the source or reply-to address of this message
*/
public Member getAddress();
/**
* Sets the source or reply-to address of this message
* @param member Member
*/
public void setAddress(Member member);
/**
* Timestamp of when the message was created.
* @return long timestamp in milliseconds
*/
public long getTimestamp();
/**
*
* Sets the timestamp of this message
* @param timestamp The timestamp
*/
public void setTimestamp(long timestamp);
/**
* Each message must have a globally unique Id.
* interceptors heavily depend on this id for message processing
* @return byte
*/
public byte[] getUniqueId();
/**
* The byte buffer that contains the actual message payload
* @param buf XByteBuffer
*/
public void setMessage(XByteBuffer buf);
/**
* returns the byte buffer that contains the actual message payload
* @return XByteBuffer
*/
public XByteBuffer getMessage();
/**
* The message options is a 32 bit flag set
* that triggers interceptors and message behavior.
* @see Channel#send(Member[], Serializable, int)
* @see ChannelInterceptor#getOptionFlag
* @return int - the option bits set for this message
*/
public int getOptions();
/**
* sets the option bits for this message
* @param options int
* @see #getOptions()
*/
public void setOptions(int options);
/**
* Shallow clone, what gets cloned depends on the implementation
* @return ChannelMessage
*/
public Object clone();
/**
* Deep clone, all fields MUST get cloned
* @return ChannelMessage
*/
public Object deepclone();
}
|
