Package org.jgroups.protocols
Class FRAG
- java.lang.Object
-
- org.jgroups.stack.Protocol
-
- org.jgroups.protocols.FRAG
-
public class FRAG extends Protocol
Fragmentation layer. Fragments messages larger than FRAG_SIZE into smaller packets. Reassembles fragmented packets into bigger ones. The fragmentation number is added to the messages as a header (and removed at the receiving side).Contrary to
FRAG2
, FRAG marshals the entire message (including the headers) into a byte[] buffer and the fragments that buffer. BecauseMessage.size()
is called rather thanMessage.getLength()
, and because of the overhead of marshalling, this will be slower than FRAG2.Each fragment is identified by (a) the sender (part of the message to which the header is appended), (b) the fragmentation ID (which is unique per FRAG layer (monotonically increasing) and (c) the fragement ID which ranges from 0 to number_of_fragments-1.
Requirement: lossless delivery (e.g. NAK, ACK). No requirement on ordering. Works for both unicast and multicast messages.
- Author:
- Bela Ban, Filip Hanik
-
-
Field Summary
-
Fields inherited from class org.jgroups.stack.Protocol
after_creation_hook, down_prot, ergonomics, id, log, stack, stats, up_prot
-
-
Constructor Summary
Constructors Constructor Description FRAG()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
down(Event evt)
Fragment a packet if larger than frag_size (add a header).java.lang.Object
down(Message msg)
A message is sent down the stack.int
getFragSize()
long
getNumberOfReceivedFragments()
long
getNumberOfReceivedMessages()
long
getNumberOfSentFragments()
long
getNumberOfSentMessages()
void
init()
Called after instance has been created (null constructor) and before protocol is started.void
resetStats()
void
setFragSize(int s)
java.lang.Object
up(Event evt)
If event is a message, if it is fragmented, re-assemble fragments into big message and pass up the stack.java.lang.Object
up(Message msg)
A single message was received.void
up(MessageBatch batch)
Sends up a multiple messages in aMessageBatch
.-
Methods inherited from class org.jgroups.stack.Protocol
accept, afterCreationHook, destroy, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop
-
-
-
-
Method Detail
-
getFragSize
public int getFragSize()
-
setFragSize
public void setFragSize(int s)
-
getNumberOfSentMessages
public long getNumberOfSentMessages()
-
getNumberOfSentFragments
public long getNumberOfSentFragments()
-
getNumberOfReceivedMessages
public long getNumberOfReceivedMessages()
-
getNumberOfReceivedFragments
public long getNumberOfReceivedFragments()
-
init
public void init() throws java.lang.Exception
Description copied from class:Protocol
Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
-
resetStats
public void resetStats()
- Overrides:
resetStats
in classProtocol
-
down
public java.lang.Object down(Event evt)
Fragment a packet if larger than frag_size (add a header). Otherwise just pass down. Only add a header if framentation is needed !
-
down
public java.lang.Object down(Message msg)
Description copied from class:Protocol
A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it before passing it down.
-
up
public java.lang.Object up(Event evt)
If event is a message, if it is fragmented, re-assemble fragments into big message and pass up the stack.
-
up
public java.lang.Object up(Message msg)
Description copied from class:Protocol
A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.
-
up
public void up(MessageBatch batch)
Description copied from class:Protocol
Sends up a multiple messages in aMessageBatch
. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages. The default processing below sends messages up the stack individually, based on a matching criteria (callingProtocol.accept(org.jgroups.Message)
), and - if true - callsProtocol.up(org.jgroups.Event)
for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped. Subclasses should check if there are any messages destined for them (e.g. usingMessageBatch.getMatchingMessages(short,boolean)
), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.
-
-