com.avaje.ebeaninternal.server.cluster

Class Packet

java.lang.Object

com.avaje.ebeaninternal.server.cluster.Packet

Direct Known Subclasses:

PacketMessages, PacketTransactionEvent

public class Packet
extends Object

Represents the contents sent as a single DatagramPacket.

The contents is typically multiple messages (ACK,PING etc) or all or part of a RemoteTransactionEvent.

Due to the hard limit on the size of UDP packets a RemoteTransactionEvent with lots of information could be broken up into multiple packets.

Author:

rbygrave

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteArrayOutputStream	buffer
protected byte[]	bytes
protected DataOutputStream	dataOut
protected long	packetId The PacketId.
protected short	packetType The type of Packet.
protected String	serverName The EbeanServer name this relates to if relevant.
protected long	timestamp The timestamp the Packet was created.
static short	TYPE_MESSAGES A Packet that holds protocol messages like ACK, PING etc.
static short	TYPE_TRANSEVENT A Packet that holds TransactionEvent information such as Bean and or Table IUD information.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Packet(boolean write, short packetType, long packetId, long timestamp, String serverName)

Method Summary

Methods

Modifier and Type	Method and Description
static Packet	forWrite(short packetType, long packetId, long timestamp, String serverName) Create a Packet for writing messages to.
byte[]	getBytes() Return the Packet as raw bytes.
long	getPacketId()
short	getPacketType()
String	getServerName()
int	getSize()
long	getTimestamp()
int	incrementResendCount()
void	read(DataInput dataInput)
static Packet	readHeader(DataInput dataInput) Create a Packet just reading the Header information.
protected void	readMessage(DataInput dataInput, int msgType) Overridden by more specific Packet implementations to read the messages.
boolean	writeBinaryMessage(BinaryMessage msg, int maxPacketSize) Write a binary message to this packet returning true if there was enough room to do so.
void	writeEof()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_MESSAGES

public static final short TYPE_MESSAGES

A Packet that holds protocol messages like ACK, PING etc.

See Also:

Constant Field Values

TYPE_TRANSEVENT

public static final short TYPE_TRANSEVENT

A Packet that holds TransactionEvent information such as Bean and or Table IUD information.

See Also:

Constant Field Values

packetType

protected short packetType

The type of Packet.

packetId

protected long packetId

The PacketId.

timestamp

protected long timestamp

The timestamp the Packet was created.

serverName

protected String serverName

The EbeanServer name this relates to if relevant.

buffer

protected ByteArrayOutputStream buffer

dataOut

protected DataOutputStream dataOut

bytes

protected byte[] bytes

Constructor Detail

Packet

protected Packet(boolean write,
      short packetType,
      long packetId,
      long timestamp,
      String serverName)
          throws IOException

Throws:

IOException

Method Detail

forWrite

public static Packet forWrite(short packetType,
              long packetId,
              long timestamp,
              String serverName)
                       throws IOException

Create a Packet for writing messages to.

Throws:

IOException

readHeader

public static Packet readHeader(DataInput dataInput)
                         throws IOException

Create a Packet just reading the Header information.

Throws:

IOException

incrementResendCount

public int incrementResendCount()

getPacketType

public short getPacketType()

getPacketId

public long getPacketId()

getTimestamp

public long getTimestamp()

getServerName

public String getServerName()

writeEof

public void writeEof()
              throws IOException

Throws:

IOException

read

public void read(DataInput dataInput)
          throws IOException

Throws:

IOException

readMessage

protected void readMessage(DataInput dataInput,
               int msgType)
                    throws IOException

Overridden by more specific Packet implementations to read the messages.

Throws:

IOException

writeBinaryMessage

public boolean writeBinaryMessage(BinaryMessage msg,
                         int maxPacketSize)
                           throws IOException

Write a binary message to this packet returning true if there was enough room to do so. Return false if the message was too large for the remaining space left - in this case another Packet should be created to put that message into.

Throws:

IOException

getSize

public int getSize()

getBytes

public byte[] getBytes()

Return the Packet as raw bytes.