com.hazelcast.nio

Class Packet

java.lang.Object

com.hazelcast.internal.serialization.impl.HeapData

com.hazelcast.nio.Packet

All Implemented Interfaces:

OutboundFrame, Data

@PrivateApi
public final class Packet
extends HeapData
implements OutboundFrame

A Packet is a piece of data send over the line. The Packet is used for member to member communication. The Packet extends HeapData instead of wrapping it. From a design point of view this is often not the preferred solution ( prefer composition over inheritance), but in this case that would mean more object litter. Since the Packet isn't used throughout the system, this design choice is visible locally.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_BIND
static int	FLAG_EVENT
static int	FLAG_OP
static int	FLAG_OP_CONTROL A flag to indicate this is a special control packet for the operation system like invocation-heartbeats.
static int	FLAG_RESPONSE
static int	FLAG_URGENT
static byte	VERSION

Fields inherited from class com.hazelcast.internal.serialization.impl.HeapData

DATA_OFFSET, HEAP_DATA_OVERHEAD, PARTITION_HASH_OFFSET, payload, TYPE_OFFSET

Constructor Summary

Constructors

Constructor and Description
Packet()
Packet(byte[] payload)
Packet(byte[] payload, int partitionId)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Connection	getConn() Gets the Connection this Packet was send with.
short	getFlags() Returns the flags of the Packet.
int	getPartitionId() Returns the partition id of this packet.
int	hashCode()
boolean	isFlagSet(int flag) Checks if a flag is set.
boolean	isUrgent() Checks if this Frame is urgent.
int	packetSize() Returns an estimation of the packet, including its payload, in bytes.
boolean	readFrom(ByteBuffer src)
void	reset()
Packet	setAllFlags(int flags) Sets all flags at once.
void	setConn(Connection conn) Sets the Connection this Packet is send with.
Packet	setFlag(int flag) Sets a particular flag.
String	toString()
boolean	writeTo(ByteBuffer dst)

Methods inherited from class com.hazelcast.internal.serialization.impl.HeapData

dataSize, getHeapCost, getPartitionHash, getType, hash64, hasPartitionHash, isPortable, toByteArray, totalSize

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final byte VERSION

See Also:

Constant Field Values

FLAG_OP

public static final int FLAG_OP

See Also:

Constant Field Values

FLAG_RESPONSE

public static final int FLAG_RESPONSE

See Also:

Constant Field Values

FLAG_EVENT

public static final int FLAG_EVENT

See Also:

Constant Field Values

FLAG_URGENT

public static final int FLAG_URGENT

See Also:

Constant Field Values

FLAG_BIND

public static final int FLAG_BIND

See Also:

Constant Field Values

FLAG_OP_CONTROL

public static final int FLAG_OP_CONTROL

A flag to indicate this is a special control packet for the operation system like invocation-heartbeats.

See Also:

Constant Field Values

Constructor Detail

Packet

public Packet()

Packet

public Packet(byte[] payload)

Packet

public Packet(byte[] payload,
      int partitionId)

Method Detail

getConn

public Connection getConn()

Gets the Connection this Packet was send with.

Returns:

the Connection. Could be null.

setConn

public void setConn(Connection conn)

Sets the Connection this Packet is send with.

This is done on the reading side of the Packet to make it possible to retrieve information about the sender of the Packet.

Parameters:

conn - the connection.

setFlag

public Packet setFlag(int flag)

Sets a particular flag. The other flags will not be touched.

Parameters:

flag - the flag to set

Returns:

this (for fluent interface)

setAllFlags

public Packet setAllFlags(int flags)

Sets all flags at once. The old flags will be completely overwritten by the new flags. The reason this method accepts an int instead of a short is that Java immediately converts to ints, so you would have to do bit shifting logic to down cast to a short all the time.*

Parameters:

flags - the flags.

Returns:

this (for fluent interface)

isFlagSet

public boolean isFlagSet(int flag)

Checks if a flag is set.

Parameters:

flag - the flag to check

Returns:

true if the flag is set, false otherwise.

getFlags

public short getFlags()

Returns the flags of the Packet. The flags is used to figure out what the content is of this Packet before the actual payload needs to be processed.

Returns:

the flags.

getPartitionId

public int getPartitionId()

Returns the partition id of this packet. If this packet is not for a particular partition, -1 is returned.

Returns:

the partition id.

reset

public void reset()

isUrgent

public boolean isUrgent()

Description copied from interface: OutboundFrame

Checks if this Frame is urgent. Frames that are urgent, have priority above regular frames. This is useful to implement System Operations so that they can be send faster than regular operations; especially when the system is under load you want these operations have precedence.

Specified by:

isUrgent in interface OutboundFrame

Returns:

true if urgent, false otherwise.

writeTo

public boolean writeTo(ByteBuffer dst)

readFrom

public boolean readFrom(ByteBuffer src)

packetSize

public int packetSize()

Returns an estimation of the packet, including its payload, in bytes.

Returns:

the size of the packet.

equals

public boolean equals(Object o)

Overrides:

equals in class HeapData

hashCode

public int hashCode()

Overrides:

hashCode in class HeapData

toString

public String toString()

Overrides:

toString in class HeapData