MessageBatch

java.lang.Object
- com.fr.third.jgroups.util.MessageBatch

所有已实现的接口:

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.

从以下版本开始:

3.3

作者:

Bela Ban

嵌套类概要

嵌套类
限定符和类型	类和说明
`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

字段概要

字段
限定符和类型	字段和说明
`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

构造器概要

构造器
构造器和说明
`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)`

方法概要

方法
限定符和类型	方法和说明
`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)

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料
- 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
```
  另请参阅:
  常量字段值

构造器详细资料

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)

方法详细资料
- 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
  
  参数:
  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
  
  返回:
- replace
```
public MessageBatch replace(Filter<Message> filter,
                   Message replacement,
                   boolean match_all)
```
  Replaces all messages which match a given filter with a replacement message
  
  参数:
  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
  
  返回:
  the MessageBatch
- remove
```
public MessageBatch remove(Message msg)
```
  Removes the current message (found by indentity (==)) by nulling it in the message array
  
  参数:
  msg -
  
  返回:
- remove
```
public MessageBatch remove(Filter<Message> filter)
```
  Removes all messages which match filter
  
  参数:
  filter - the filter. If null, no removal takes place
  
  返回:
  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
  
  指定者:
  
  iterator 在接口中 java.lang.Iterable<Message>
- toString
```
public java.lang.String toString()
```
  覆盖:
  
  toString 在类中 java.lang.Object
- printHeaders
```
public java.lang.String printHeaders()
```
- resize
```
protected void resize()
```

类 MessageBatch

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

dest

sender

cluster_name

messages

index

multicast

mode

INCR

构造器详细资料

MessageBatch

MessageBatch

MessageBatch

MessageBatch

MessageBatch

方法详细资料

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