MessageBatch

java.lang.Object
- org.jgroups.util.MessageBatch

All Implemented Interfaces:

java.lang.Iterable<Message>
```
public class MessageBatch
extends java.lang.Object
implements java.lang.Iterable<Message>
```
Represents a message batch; multiple messages from the same sender to the same receiver(s). This class is unsynchronized.

Since:

3.3

Author:

Bela Ban

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`MessageBatch.BatchIterator` Iterates over non-null elements of a batch, skipping null elements
`static class`	`MessageBatch.Mode`
`static interface`	`MessageBatch.Visitor<T>` Used for iteration over the messages

Field Summary

Fields
Modifier and Type	Field and Description
`protected AsciiString`	`cluster_name` The name of the cluster in which the message batch is sent, this is equivalent to TpHeader.cluster_name
`protected Address`	`dest` The destination address.
`protected static int`	`INCR`
`protected int`	`index` Index of the next message to be inserted
`protected Message[]`	`messages` The storage of the messages; removed messages have a null element
`protected MessageBatch.Mode`	`mode` Whether this message batch contains only OOB messages, or only regular messages
`protected boolean`	`multicast` Whether all messages have dest == null (multicast) or not
`protected Address`	`sender` The sender of the message batch

Constructor Summary

Constructors
Constructor and Description
`MessageBatch(Address dest, Address sender, AsciiString cluster_name, boolean multicast, java.util.Collection<Message> msgs)`
`MessageBatch(Address dest, Address sender, AsciiString cluster_name, boolean multicast, java.util.Collection<Message> msgs, Filter<Message> filter)`
`MessageBatch(Address dest, Address sender, AsciiString cluster_name, boolean multicast, MessageBatch.Mode mode, int capacity)`
`MessageBatch(java.util.Collection<Message> msgs)`
`MessageBatch(int capacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageBatch`	`add(Message msg)`
`Message[]`	`array()` Returns the underlying message array.
`int`	`capacity()`
`MessageBatch`	`clear()`
`AsciiString`	`clusterName()`
`MessageBatch`	`clusterName(AsciiString name)`
`Address`	`dest()`
`MessageBatch`	`dest(Address dest)`
`MessageBatch.Mode`	`determineMode()`
`Message`	`first()`
`java.util.Collection<Message>`	`getMatchingMessages(short id, boolean remove)` Removes and returns all messages which have a header with ID == id
`boolean`	`isEmpty()`
`java.util.Iterator<Message>`	`iterator()` Iterator which iterates only over non-null messages, skipping null messages
`Message`	`last()`
`int`	`length()` Returns the total number of bytes of the message batch (by calling `Message.getLength()` on all messages)
`<T> java.util.Collection<T>`	`map(MessageBatch.Visitor<T> visitor)` Applies a function to all messages and returns a list of the function results
`MessageBatch.Mode`	`mode()`
`MessageBatch`	`mode(MessageBatch.Mode mode)`
`boolean`	`multicast()`
`java.lang.String`	`printHeaders()`
`MessageBatch`	`remove(Filter<Message> filter)` Removes all messages which match filter
`MessageBatch`	`remove(Message msg)` Removes the current message (found by indentity (==)) by nulling it in the message array
`MessageBatch`	`replace(Filter<Message> filter, Message replacement, boolean match_all)` Replaces all messages which match a given filter with a replacement message
`MessageBatch`	`replace(Message existing_msg, Message new_msg)` Replaces a message in the batch with another one
`protected void`	`resize()`
`Address`	`sender()`
`MessageBatch`	`sender(Address sender)`
`int`	`size()` Returns the number of non-null messages
`java.lang.String`	`toString()`
`long`	`totalSize()` Returns the size of the message batch (by calling `Message.size()` on all messages)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Field Detail
- dest
```
protected Address dest
```
  The destination address. Null if this is a multicast message batch, non-null if the batch is sent to a specific member
- sender
```
protected Address sender
```
  The sender of the message batch
- cluster_name
```
protected AsciiString cluster_name
```
  The name of the cluster in which the message batch is sent, this is equivalent to TpHeader.cluster_name
- messages
```
protected Message[] messages
```
  The storage of the messages; removed messages have a null element
- index
```
protected int index
```
  Index of the next message to be inserted
- multicast
```
protected boolean multicast
```
  Whether all messages have dest == null (multicast) or not
- mode
```
protected MessageBatch.Mode mode
```
  Whether this message batch contains only OOB messages, or only regular messages
- INCR
```
protected static final int INCR
```
  See Also:
  
  Constant Field Values

Constructor Detail

MessageBatch
```
public MessageBatch(int capacity)
```

MessageBatch

public MessageBatch(java.util.Collection<Message> msgs)

MessageBatch

public MessageBatch(Address dest,
                    Address sender,
                    AsciiString cluster_name,
                    boolean multicast,
                    java.util.Collection<Message> msgs)

MessageBatch

public MessageBatch(Address dest,
                    Address sender,
                    AsciiString cluster_name,
                    boolean multicast,
                    java.util.Collection<Message> msgs,
                    Filter<Message> filter)

MessageBatch

public MessageBatch(Address dest,
                    Address sender,
                    AsciiString cluster_name,
                    boolean multicast,
                    MessageBatch.Mode mode,
                    int capacity)

Method Detail
- dest
```
public Address dest()
```
- dest
```
public MessageBatch dest(Address dest)
```
- sender
```
public Address sender()
```
- sender
```
public MessageBatch sender(Address sender)
```
- clusterName
```
public AsciiString clusterName()
```
- clusterName
```
public MessageBatch clusterName(AsciiString name)
```
- multicast
```
public boolean multicast()
```
- mode
```
public MessageBatch.Mode mode()
```
- mode
```
public MessageBatch mode(MessageBatch.Mode mode)
```
- capacity
```
public int capacity()
```
- array
```
public Message[] array()
```
  Returns the underlying message array. This is only intended for testing !
- first
```
public Message first()
```
- last
```
public Message last()
```
- add
```
public MessageBatch add(Message msg)
```
- replace
```
public MessageBatch replace(Message existing_msg,
                            Message new_msg)
```
  Replaces a message in the batch with another one
  
  Parameters:
  
  existing_msg - The message to be replaced. The message has to be non-null and is found by identity (==) comparison
  
  new_msg - The message to replace the existing message with, can be null
  
  Returns:
- replace
```
public MessageBatch replace(Filter<Message> filter,
                            Message replacement,
                            boolean match_all)
```
  Replaces all messages which match a given filter with a replacement message
  
  Parameters:
  
  filter - the filter. If null, no changes take place. Note that filter needs to be able to handle null msgs
  
  replacement - the replacement message. Can be null, which essentially removes all messages matching filter
  
  match_all - whether to replace the first or all matches
  
  Returns:
  
  the MessageBatch
- remove
```
public MessageBatch remove(Message msg)
```
  Removes the current message (found by indentity (==)) by nulling it in the message array
  
  Parameters:
  
  msg -
  
  Returns:
- remove
```
public MessageBatch remove(Filter<Message> filter)
```
  Removes all messages which match filter
  
  Parameters:
  
  filter - the filter. If null, no removal takes place
  
  Returns:
  
  the MessageBatch
- clear
```
public MessageBatch clear()
```
- getMatchingMessages
```
public java.util.Collection<Message> getMatchingMessages(short id,
                                                         boolean remove)
```
  Removes and returns all messages which have a header with ID == id
- map
```
public <T> java.util.Collection<T> map(MessageBatch.Visitor<T> visitor)
```
  Applies a function to all messages and returns a list of the function results
- size
```
public int size()
```
  Returns the number of non-null messages
- isEmpty
```
public boolean isEmpty()
```
- determineMode
```
public MessageBatch.Mode determineMode()
```
- totalSize
```
public long totalSize()
```
  Returns the size of the message batch (by calling Message.size() on all messages)
- length
```
public int length()
```
  Returns the total number of bytes of the message batch (by calling Message.getLength() on all messages)
- iterator
```
public java.util.Iterator<Message> iterator()
```
  Iterator which iterates only over non-null messages, skipping null messages
  
  Specified by:
  
  iterator in interface java.lang.Iterable<Message>
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- printHeaders
```
public java.lang.String printHeaders()
```
- resize
```
protected void resize()
```

Class MessageBatch

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

dest

sender

cluster_name

messages

index

multicast

mode

INCR

Constructor Detail

MessageBatch

MessageBatch

MessageBatch

MessageBatch

MessageBatch

Method Detail

dest

dest

sender

sender

clusterName

clusterName

multicast

mode

mode

capacity

array

first

last

add

replace

replace

remove

remove

clear

getMatchingMessages

map

size

isEmpty

determineMode

totalSize

length

iterator

toString

printHeaders

resize