## Uses of Class
org.jgroups.Message

Packages that use Message
Package | Description
--- | ---
org.jgroups | Provides top-level public JGroups classes such as Channel, Message, etc.
org.jgroups.auth |
org.jgroups.blocks | Provides building blocks that are layered on top of channels.
org.jgroups.blocks.mux |
org.jgroups.debug | Provides debug support, including testing, profiling, and a graphical view of a protocol stack.
org.jgroups.demos | Provides demonstrations of JGroups functionality.
org.jgroups.demos.wb | A distributed whiteboard applet implemented using JGroups.
org.jgroups.mux |
org.jgroups.protocols | Provides implementations of transport protocols which are responsible for sending and receiving messages to/from the network.
org.jgroups.stack | Support for managing protocol stacks.
org.jgroups.util | Provides useful functionality which cannot be assigned to any particular other package.

### Uses of Message in org.jgroups

Methods in org.jgroups that return Message
Modifier and Type | Method and Description
--- | ---
`Message` | Message.`copy()`
`Message` | Message.`copy(boolean copy_buffer)` Create a copy of the message.
`Message` | Message.`copy(boolean copy_buffer, boolean copy_headers)` Create a copy of the message.
`Message` | Message.`copy(boolean copy_buffer, short starting_id)` Doesn't copy any headers except for those with ID >= copy_headers_above
`Message` | Message.`makeReply()`

Methods in org.jgroups with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`void` | ReceiverAdapter.`receive(Message msg)`
`void` | ExtendedReceiverAdapter.`receive(Message msg)`
`void` | MessageListener.`receive(Message msg)` Called when a message is received.
`abstract void` | Channel.`send(Message msg)` Sends a message to a (unicast) destination.
`void` | JChannel.`send(Message msg)` Sends a message through the protocol stack.
`void` | Transport.`send(Message msg)`

### Uses of Message in org.jgroups.auth

Methods in org.jgroups.auth with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`boolean` | MD5Token.`authenticate(AuthToken token, Message msg)`
`boolean` | RegexMembership.`authenticate(AuthToken token, Message msg)`
`boolean` | X509Token.`authenticate(AuthToken token, Message msg)`
`abstract boolean` | AuthToken.`authenticate(AuthToken token, Message msg)` This method should be implemented to perform the actual authentication of joining members.
`boolean` | SimpleToken.`authenticate(AuthToken token, Message msg)`
`boolean` | FixedMembershipToken.`authenticate(AuthToken token, Message msg)`

### Uses of Message in org.jgroups.blocks

Fields in org.jgroups.blocks declared as Message
Modifier and Type | Field and Description
--- | ---
`protected Message` | Request.`request_msg`

Methods in org.jgroups.blocks with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`protected GroupRequest` | MessageDispatcher.`cast(java.util.Collection<Address> dests, Message msg, RequestOptions options, boolean block_for_results)`
`RspList` | MessageDispatcher.`castMessage(java.util.Collection<Address> dests, Message msg, RequestOptions options)` Sends a message to the members listed in dests.
`RspList` | MessageDispatcher.`castMessage(java.util.Vector dests, Message msg, int mode, long timeout)` Deprecated.
`RspList` | MessageDispatcher.`castMessage(java.util.Vector dests, Message msg, int mode, long timeout, boolean use_anycasting)` Deprecated.
`RspList` | MessageDispatcher.`castMessage(java.util.Vector dests, Message msg, int mode, long timeout, boolean use_anycasting, RspFilter filter)` Deprecated.
`NotifyingFuture<RspList>` | MessageDispatcher.`castMessageWithFuture(java.util.Collection<Address> dests, Message msg, RequestOptions options)`
`NotifyingFuture<RspList>` | MessageDispatcher.`castMessageWithFuture(java.util.Vector dests, Message msg, int mode, long timeout, boolean use_anycasting, RspFilter filter)` Deprecated.
`java.lang.Object` | MessageDispatcher.`handle(Message msg)`
`java.lang.Object` | RequestHandler.`handle(Message msg)`
`java.lang.Object` | RpcDispatcher.`handle(Message req)` Message contains MethodCall.
`protected void` | PullPushAdapter.`handleMessage(Message msg)` Deprecated. Check whether the message has an identifier.
`protected void` | RequestCorrelator.`handleRequest(Message req, RequestCorrelator.Header hdr)` Handle a request msg for this correlator
`protected void` | RequestCorrelator.`prepareResponse(Message rsp)`
`void` | DistributedTree.`receive(Message msg)`
`void` | MessageListenerAdapter.`receive(Message msg)` Receive message from group.
`void` | DistributedQueue.`receive(Message msg)`
`void` | ReplicatedTree.`receive(Message msg)` Callback.
`void` | VotingAdapter.`receive(Message msg)` Receive the message.
`void` | ReplicatedHashMap.`receive(Message msg)`
`void` | NotificationBus.`receive(Message msg)` Deprecated.
`boolean` | RequestCorrelator.`receiveMessage(Message msg)` Handles a message coming from a layer below
`void` | MessageDispatcher.`send(Message msg)` Deprecated.
`void` | PullPushAdapter.`send(Message msg)` Deprecated. Sends a message with no identifier; listener member will get this message on the other group members.
`void` | PullPushAdapter.`send(java.io.Serializable identifier, Message msg)` Deprecated. Sends a message to the group - listeners to this identifier will receive the messages.
`java.lang.Object` | MessageDispatcher.`sendMessage(Message msg, int mode, long timeout)` Deprecated. Use `MessageDispatcher.sendMessage(org.jgroups.Message, RequestOptions)` instead
`java.lang.Object` | MessageDispatcher.`sendMessage(Message msg, RequestOptions opts)`
`<T> NotifyingFuture<T>` | MessageDispatcher.`sendMessageWithFuture(Message msg, int mode, long timeout)` Deprecated.
`<T> NotifyingFuture<T>` | MessageDispatcher.`sendMessageWithFuture(Message msg, RequestOptions options)`
`void` | RequestCorrelator.`sendRequest(long id, java.util.Collection<Address> dest_mbrs, Message msg, RspCollector coll, RequestOptions options)` Sends a request to a group.
`void` | RequestCorrelator.`sendRequest(long id, java.util.List<Address> dest_mbrs, Message msg, RspCollector coll)`
`void` | RequestCorrelator.`sendRequest(long id, Message msg, RspCollector coll)` Deprecated.
`void` | RequestCorrelator.`sendUnicastRequest(long id, Address target, Message msg, RspCollector coll)` Sends a request to a single destination

Constructors in org.jgroups.blocks with parameters of type Message
Constructor and Description
`GroupRequest(Message m, RequestCorrelator corr, Address target, RequestOptions options)`
`GroupRequest(Message msg, RequestCorrelator corr, java.util.Collection<Address> targets, RequestOptions options)`
`GroupRequest(Message m, Transport transport, java.util.Collection<Address> mbrs, RequestOptions options)`
`MultiRequest(Message m, RequestCorrelator corr, Address target, RequestOptions options, int expected_mbrs)`
`MultiRequest(Message m, RequestCorrelator corr, java.util.Collection<Address> mbrs, RequestOptions options, int expected_mbrs)`
`MultiRequest(Message m, Transport transport, java.util.Collection<Address> mbrs, RequestOptions options, int expected_mbrs)`
`Request(Message request, RequestCorrelator corr, Transport transport, RequestOptions options)`
`Request(Message request, RequestCorrelator corr, Transport transport, RspFilter filter, int mode, long timeout)` Deprecated.
`UnicastRequest(Message m, RequestCorrelator corr, Address target, RequestOptions options)`
`UnicastRequest(Message m, Transport transport, Address target, RequestOptions options)`

### Uses of Message in org.jgroups.blocks.mux

Methods in org.jgroups.blocks.mux with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`protected GroupRequest` | MuxMessageDispatcher.`cast(java.util.Collection<Address> dests, Message msg, RequestOptions options, boolean blockForResults)`
`protected GroupRequest` | MuxRpcDispatcher.`cast(java.util.Collection<Address> dests, Message msg, RequestOptions options, boolean blockForResults)`
`protected void` | MuxRequestCorrelator.`prepareResponse(Message rsp)`
`void` | MuxRequestCorrelator.`sendRequest(long requestId, java.util.Collection<Address> dest_mbrs, Message msg, RspCollector coll, RequestOptions options)`
`void` | MuxRequestCorrelator.`sendUnicastRequest(long id, Address target, Message msg, RspCollector coll)`

### Uses of Message in org.jgroups.debug

Methods in org.jgroups.debug with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`boolean` | Simulator.`checkForDropMessage(Message msg, Address dest)`
`boolean` | Simulator.DropMessage.`drop(Message msg, Address dest)`
`boolean` | Simulator.`receiverDropFault(Message msg, Address src)`
`boolean` | Simulator.`senderDropFault(Message msg, Address dest)`

### Uses of Message in org.jgroups.demos

Methods in org.jgroups.demos with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`void` | QuoteServer.`receive(Message msg)`
`void` | Draw.`receive(Message msg)`

### Uses of Message in org.jgroups.demos.wb

Methods in org.jgroups.demos.wb with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`void` | Whiteboard.`receive(Message m)`

### Uses of Message in org.jgroups.mux

Methods in org.jgroups.mux with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`void` | MuxChannel.`send(Message msg)` Deprecated.

### Uses of Message in org.jgroups.protocols

Fields in org.jgroups.protocols with type parameters of type Message
Modifier and Type | Field and Description
--- | ---
`protected java.util.List<Message>` | SHUFFLE.`down_msgs`
`protected java.util.concurrent.BlockingQueue<Message>` | DAISYCHAIN.`forward_queue`
`protected java.util.concurrent.BlockingQueue<Message>` | DAISYCHAIN.`send_queue`
`protected java.util.List<Message>` | SHUFFLE.`up_msgs`

Methods in org.jgroups.protocols that return Message
Modifier and Type | Method and Description
--- | ---
`Message` | TransportedVectorTime.`getAssociatedMessage()` Returns a message associated with this vector timestamp.
`protected static Message` | TP.`readMessage(java.io.DataInputStream instream)`
`Message` | SCOPE.MessageQueue.`remove()`

Methods in org.jgroups.protocols that return types with arguments of type Message
Modifier and Type | Method and Description
--- | ---
`protected static java.util.List<Message>` | TP.`readMessageList(java.io.DataInputStream in)`

Methods in org.jgroups.protocols with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`void` | SCOPE.MessageQueue.`add(Message msg)`
`protected void` | RELAY.`forwardToCoord(Message msg)` Wraps the message annd sends it to the current coordinator
`protected java.lang.Object` | UFC.`handleDownMessage(Event evt, Message msg, Address dest, int length)`
`protected java.lang.Object` | MFC.`handleDownMessage(Event evt, Message msg, Address dest, int length)`
`protected abstract java.lang.Object` | FlowControl.`handleDownMessage(Event evt, Message msg, Address dest, int length)`
`protected void` | TP.`passMessageUp(Message msg, boolean perform_cluster_name_matching, boolean multicast, boolean discard_own_mcast)`
`void` | RELAY.Receiver.`receive(Message msg)`
`void` | UNICAST.`retransmit(long seqno, Message msg)` Called by AckSenderWindow to resend messages for which no ACK has been received yet
`void` | SMACK.`retransmit(long seqno, Message msg, Address dest)`
`void` | TP.Bundler.`send(Message msg)`
`protected void` | TUNNEL.`send(Message msg, Address dest, boolean multicast)`
`protected void` | TP.`send(Message msg, Address dest, boolean multicast)` Serializes and sends a message.
`void` | TransportedVectorTime.`setAssociatedMessage(Message owner)` Sets a message associated with this vector timestamp
`protected void` | TP.`setSourceAddress(Message msg)` If the sender is null, set our own address.
`protected static void` | TP.`writeMessage(Message msg, java.io.DataOutputStream dos, boolean multicast)` This method needs to be synchronized on out_stream when it is called

Method parameters in org.jgroups.protocols with type arguments of type Message
Modifier and Type | Method and Description
--- | ---
`protected static void` | TP.`writeMessageList(Address dest, Address src, java.util.List<Message> msgs, java.io.DataOutputStream dos, boolean multicast)` Write a lits of messages with the same destination and *mostly* the same src addresses.

### Uses of Message in org.jgroups.stack

Fields in org.jgroups.stack declared as Message
Modifier and Type | Field and Description
--- | ---
`static Message` | AckReceiverWindow.`TOMBSTONE`

Methods in org.jgroups.stack that return Message
Modifier and Type | Method and Description
--- | ---
`Message` | NakReceiverWindow.`get(long seqno)` Returns the message from xmit_table
`Message` | AckSenderWindow.`get(long seqno)`
`Message` | AckSenderWindow.`getLowestMessage()` Returns the message with the lowest seqno
`Message` | NakReceiverWindow.`remove()`
`Message` | AckReceiverWindow.`remove()` Removes a message whose seqno is equal to `next_to_remove`, increments the latter.
`Message` | NakReceiverWindow.`remove(boolean acquire_lock, boolean remove_msg)`

Methods in org.jgroups.stack that return types with arguments of type Message
Modifier and Type | Method and Description
--- | ---
`java.util.List<Message>` | NakReceiverWindow.`get(long from, long to)` Returns a list of messages in the range [from ..
`java.util.List<Message>` | NakReceiverWindow.`removeMany(java.util.concurrent.atomic.AtomicBoolean processing)` Removes as many messages as possible
`java.util.List<Message>` | NakReceiverWindow.`removeMany(java.util.concurrent.atomic.AtomicBoolean processing, boolean remove_msgs, int max_results)` Removes as many messages as possible
`Tuple<java.util.List<Message>,java.lang.Long>` | AckReceiverWindow.`removeMany(int max)` Removes as many messages as possible (in sequence, without gaps)
`java.util.List<Message>` | AckReceiverWindow.`removeManyAsList(int max)`

Methods in org.jgroups.stack with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`boolean` | NakReceiverWindow.`add(long seqno, Message msg)` Adds a message according to its seqno (sequence number).
`void` | AckSenderWindow.`add(long seqno, Message msg)` Adds a new message to the retransmission table.
`boolean` | AckReceiverWindow.`add(long seqno, Message msg)` Adds a new message.
`void` | AckMcastSenderWindow.`add(long seqno, Message msg, java.util.Vector receivers)` Adds a new message to the hash table.
`byte` | AckReceiverWindow.`add2(long seqno, Message msg)` Adds a message if not yet received
`void` | AckSenderWindow.`addToMessages(long seqno, Message msg)`
`void` | AckSenderWindow.`addToRetransmitter(long seqno, Message msg)`
`void` | AckSenderWindow.RetransmitCommand.`retransmit(long seqno, Message msg)`
`void` | AckMcastSenderWindow.RetransmitCommand.`retransmit(long seqno, Message msg, Address dest)` Retranmit the given msg
`void` | ProtocolStack.`send(Message msg)`

### Uses of Message in org.jgroups.util

Fields in org.jgroups.util declared as Message
Modifier and Type | Field and Description
--- | ---
`protected Message[][]` | RetransmitTable.`matrix`

Fields in org.jgroups.util with type parameters of type Message
Modifier and Type | Field and Description
--- | ---
`protected java.util.Collection<Message>` | MyReceiver.`msgs`

Methods in org.jgroups.util that return Message
Modifier and Type | Method and Description
--- | ---
`static Message` | Util.`byteBufferToMessage(byte[] buffer, int offset, int length)`
`Message` | RetransmitTable.`get(long seqno)`
`protected Message[]` | RetransmitTable.`getRow(int index)` Returns a row.
`Message` | RetransmitTable.`putIfAbsent(long seqno, Message msg)` Adds a message if the element at the given index is null.
`Message` | RetransmitTable.`remove(long seqno)` Removes the message with seqno from the table, nulls the index

Methods in org.jgroups.util that return types with arguments of type Message
Modifier and Type | Method and Description
--- | ---
`static java.util.List<Message>` | Util.`byteBufferToMessageList(byte[] buffer, int offset, int length)`
`java.util.List<Message>` | RetransmitTable.`get(long from, long to)`
`java.util.Collection<Message>` | MyReceiver.`getMsgs()`

Methods in org.jgroups.util with parameters of type Message
Modifier and Type | Method and Description
--- | ---
`static short` | Util.`getScope(Message msg)`
`static SCOPE.ScopeHeader` | Util.`getScopeHeader(Message msg)`
`static Buffer` | Util.`messageToByteBuffer(Message msg)`
`static java.lang.String` | Util.`printMessage(Message msg)` Tries to read an object from the message's buffer and prints it
`static java.lang.String` | Util.`printMethodCall(Message msg)` Tries to read a `MethodCall` object from the message's buffer and prints it.
`boolean` | RetransmitTable.`put(long seqno, Message msg)` Adds a new message to the index computed as a function of seqno
`Message` | RetransmitTable.`putIfAbsent(long seqno, Message msg)` Adds a message if the element at the given index is null.
`void` | MyReceiver.`receive(Message msg)`
`static void` | Util.`setScope(Message msg, short scope)`

Method parameters in org.jgroups.util with type arguments of type Message
Modifier and Type | Method and Description
--- | ---
`static Buffer` | Util.`msgListToByteBuffer(java.util.List<Message> xmit_list)` Marshalls a list of messages.