Packet (hazelcast-client-protocol 1.0.0 API)

java.lang.Object
- com.hazelcast.internal.serialization.impl.HeapData
- - com.hazelcast.nio.Packet

All Implemented Interfaces:

OutboundFrame, Data
```
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 and old-client 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`	`HEADER_BIND`
`static int`	`HEADER_EVENT`
`static int`	`HEADER_OP`
`static int`	`HEADER_RESPONSE`
`static int`	`HEADER_URGENT`
`static int`	`HEADER_WAN_REPLICATION`
`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)

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

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`done()`
`boolean`	`equals(Object o)`
`Connection`	`getConn()` Gets the Connection this Packet was send with.
`short`	`getHeader()` Returns the header of the Packet.
`int`	`getPartitionId()` Returns the partition id of this packet.
`int`	`hashCode()`
`boolean`	`isHeaderSet(int bit)`
`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()`
`void`	`setConn(Connection conn)` Sets the Connection this Packet is send with.
`void`	`setHeader(int bit)`
`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
  - HEADER_OP
```
public static final int HEADER_OP
```
    See Also:
    Constant Field Values
  - HEADER_RESPONSE
```
public static final int HEADER_RESPONSE
```
    See Also:
    Constant Field Values
  - HEADER_EVENT
```
public static final int HEADER_EVENT
```
    See Also:
    Constant Field Values
  - HEADER_WAN_REPLICATION
```
public static final int HEADER_WAN_REPLICATION
```
    See Also:
    Constant Field Values
  - HEADER_URGENT
```
public static final int HEADER_URGENT
```
    See Also:
    Constant Field Values
  - HEADER_BIND
```
public static final int HEADER_BIND
```
    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.
  - setHeader
```
public void setHeader(int bit)
```
  - isHeaderSet
```
public boolean isHeaderSet(int bit)
```
  - getHeader
```
public short getHeader()
```
    Returns the header of the Packet. The header is used to figure out what the content is of this Packet before the actual payload needs to be processed.
    
    Returns:
    the header.
  - 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.
  - 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.
  - done
```
public boolean done()
```
  - reset
```
public void reset()
```
  - 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

Class Packet

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

VERSION

HEADER_OP

HEADER_RESPONSE

HEADER_EVENT

HEADER_WAN_REPLICATION

HEADER_URGENT

HEADER_BIND

Constructor Detail

Packet

Packet

Packet

Method Detail

getConn

setConn

setHeader

isHeaderSet

getHeader

getPartitionId

isUrgent

writeTo

readFrom

packetSize

done

reset

equals

hashCode

toString