Package org.jgroups

Class FragmentedMessage

java.lang.Object

org.jgroups.BaseMessage

org.jgroups.BytesMessage

org.jgroups.FragmentedMessage

All Implemented Interfaces:

Constructable<Message>, Message, SizeStreamable, Streamable

public class FragmentedMessage
extends BytesMessage

A message which refers to another message, but only marshals (Streamable.writeTo(DataOutput)) a part of the original message, starting at a given BytesMessage.offset and marshalling only BytesMessage.length bytes.
The marshalling is done using PartialOutputStream.
Used by FRAG4.

Since:

5.0

Author:

Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgroups.Message

Message.Flag, Message.TransientFlag

Field Summary

Fields

Modifier and Type	Field	Description
protected Message	original_msg

Fields inherited from class org.jgroups.BytesMessage

array, length, offset

Fields inherited from class org.jgroups.BaseMessage

dest, flags, headers, sender, transient_flags

Fields inherited from interface org.jgroups.Message

BYTES_MSG, COMPOSITE_MSG, EARLYBATCH_MSG, EMPTY_MSG, FRAG_MSG, LONG_MSG, NIO_MSG, OBJ_MSG

Constructor Summary

Constructors

Constructor	Description
FragmentedMessage()
FragmentedMessage(Message original_msg, int off, int len)

Method Summary

Modifier and Type	Method	Description
protected Message	copyPayload(Message copy)	Copies the byte array.
java.util.function.Supplier<Message>	create()	Creates an instance of the class implementing this interface
protected <T extends BytesMessage> T	createMessage()
Message	getOriginalMessage()
short	getType()	Returns the type of the message, e.g.
boolean	hasArray()	Returns true if this message has a byte[] array as payload (even if it's null!), false otherwise
boolean	hasPayload()	Returns true if the message has a payload, e.g.
void	readPayload(java.io.DataInput in)
protected int	sizeOfPayload()
java.lang.String	toString()
void	writePayload(java.io.DataOutput out)

Methods inherited from class org.jgroups.BytesMessage

getArray, getLength, getObject, getObject, getOffset, setArray, setArray, setFlag, setObject, size

Methods inherited from class org.jgroups.BaseMessage

clearFlag, clearFlag, clearHeaders, copy, createHeaders, getDest, getFlags, getHeader, getHeaders, getNumHeaders, getPayload, getSrc, headers, headers, isFlagSet, isFlagSet, printHeaders, putHeader, readFrom, serializedSize, setDest, setFlag, setFlag, setFlagIfAbsent, setPayload, setSrc, writeTo, writeToNoAddrs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgroups.Message

dest, dest, getFlags, setArray, setFlag, src, src

Field Detail

original_msg

protected Message original_msg

Constructor Detail

FragmentedMessage

public FragmentedMessage()

FragmentedMessage

public FragmentedMessage(Message original_msg,
                         int off,
                         int len)

Method Detail

getOriginalMessage

public Message getOriginalMessage()

getType

public short getType()

Description copied from interface: Message

Returns the type of the message, e.g. BYTES_MSG, OBJ_MSG etc

Specified by:

getType in interface Message

Overrides:

getType in class BytesMessage

hasArray

public boolean hasArray()

Description copied from interface: Message

Returns true if this message has a byte[] array as payload (even if it's null!), false otherwise

Specified by:

hasArray in interface Message

Overrides:

hasArray in class BytesMessage

hasPayload

public boolean hasPayload()

Description copied from interface: Message

Returns true if the message has a payload, e.g. a byte[] array in a BytesMessage or an object in an ObjectMessage. This is more generic than Message.hasArray(), as it is not just applicable to a byte array.

Specified by:

hasPayload in interface Message

Overrides:

hasPayload in class BytesMessage

Returns:

True if the message has a payload

create

public java.util.function.Supplier<Message> create()

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

Specified by:

create in interface Constructable<Message>

Overrides:

create in class BytesMessage

sizeOfPayload

protected int sizeOfPayload()

Overrides:

sizeOfPayload in class BytesMessage

copyPayload

protected Message copyPayload(Message copy)

Description copied from class: BytesMessage

Copies the byte array. If offset and length are used (to refer to another array), the copy will contain only the subset that offset and length point to, copying the subset into the new copy.

Note that for headers, only the arrays holding references to the headers are copied, not the headers themselves ! The consequence is that the headers array of the copy hold the *same* references as the original, so do *not* modify the headers ! If you want to change a header, copy it and call BaseMessage.putHeader(short,Header) again.

Overrides:

copyPayload in class BytesMessage

writePayload

public void writePayload(java.io.DataOutput out)
                  throws java.io.IOException

Specified by:

writePayload in interface Message

Overrides:

writePayload in class BytesMessage

Throws:

java.io.IOException

readPayload

public void readPayload(java.io.DataInput in)
                 throws java.io.IOException

Specified by:

readPayload in interface Message

Overrides:

readPayload in class BytesMessage

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class BaseMessage

createMessage

protected <T extends BytesMessage> T createMessage()

Overrides:

createMessage in class BytesMessage