Package org.apache.ignite.internal.managers.communication

Class GridIoMessage

java.lang.Object

org.apache.ignite.internal.managers.communication.GridIoMessage

All Implemented Interfaces:

Serializable, SpanTransport, Message

Direct Known Subclasses:

GridIoSecurityAwareMessage

public class GridIoMessage
extends Object
implements Message, SpanTransport

Wrapper for all grid messages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Integer	STRIPE_DISABLED_PART

Fields inherited from interface org.apache.ignite.plugin.extensions.communication.Message

DIRECT_TYPE_SIZE

Constructor Summary

Constructors

Constructor	Description
GridIoMessage()	No-op constructor to support Externalizable interface.
GridIoMessage(byte plc, Object topic, int topicOrd, Message msg, boolean ordered, long timeout, boolean skipOnTimeout)

Method Summary

Modifier and Type	Method	Description
short	directType()	Gets message type.
boolean	equals(Object obj)
@Nullable String	executorName()
byte	fieldsCount()	Gets fields count.
int	hashCode()
Message	message()
void	onAckReceived()	Method called when ack message received.
int	partition()	Get single partition for this message (if applicable).
boolean	readFrom(ByteBuffer buf, MessageReader reader)	Reads this message from provided byte buffer.
boolean	skipOnTimeout()
byte[]	span()
void	span(byte[] span)	Stored span for transferring.
long	timeout()
String	toString()
boolean	writeTo(ByteBuffer buf, MessageWriter writer)	Writes this message to provided byte buffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STRIPE_DISABLED_PART

public static final Integer STRIPE_DISABLED_PART

Constructor Detail

GridIoMessage

public GridIoMessage()

No-op constructor to support Externalizable interface. This constructor is not meant to be used for other purposes.

GridIoMessage

public GridIoMessage(byte plc,
                     Object topic,
                     int topicOrd,
                     Message msg,
                     boolean ordered,
                     long timeout,
                     boolean skipOnTimeout)

Parameters:

plc - Policy.

topic - Communication topic.

topicOrd - Topic ordinal value.

msg - Message.

ordered - Message ordered flag.

timeout - Timeout.

skipOnTimeout - Whether message can be skipped on timeout.

Method Detail

message

public Message message()

Returns:

Message.

timeout

public long timeout()

Returns:

Message timeout.

skipOnTimeout

public boolean skipOnTimeout()

Returns:

Whether message can be skipped on timeout.

onAckReceived

public void onAckReceived()

Method called when ack message received.

Specified by:

onAckReceived in interface Message

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

writeTo

public boolean writeTo(ByteBuffer buf,
                       MessageWriter writer)

Writes this message to provided byte buffer.

Specified by:

writeTo in interface Message

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf,
                        MessageReader reader)

Reads this message from provided byte buffer.

Specified by:

readFrom in interface Message

Parameters:

buf - Byte buffer.

reader - Reader.

Returns:

Whether message was fully read.

directType

public short directType()

Gets message type.

Specified by:

directType in interface Message

Returns:

Message type.

fieldsCount

public byte fieldsCount()

Gets fields count.

Specified by:

fieldsCount in interface Message

Returns:

Fields count.

span

public void span(byte[] span)

Stored span for transferring.

Specified by:

span in interface SpanTransport

Parameters:

span - Binary view of span.

span

public byte[] span()

Specified by:

span in interface SpanTransport

Returns:

Binary view of span.

partition

public int partition()

Get single partition for this message (if applicable).

Returns:

Partition ID.

executorName

@Nullable
public @Nullable String executorName()

Returns:

Executor name (if available).

toString

public String toString()

Overrides:

toString in class Object