com.serotonin.mango.rt.publish.persistent

Class Packet

java.lang.Object

com.serotonin.mango.rt.publish.persistent.Packet

public class Packet
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private static java.nio.charset.Charset	CHARSET
static int	DATA_SOURCE_SOCKET_TIMEOUT
static byte[]	EMPTY
(package private) static org.apache.commons.pool.ObjectPool	packetPool
private com.serotonin.util.queue.ByteQueue	payload
private static byte[]	PAYLOAD_READ_BUFFER
private static int	PAYLOAD_READ_TIMEOUT
static int	PUBLISHER_SOCKET_TIMEOUT
static int	TEST_PACKET_SEND_DELAY
private PacketType	type

Constructor Summary

Constructors

Constructor and Description
Packet()

Method Summary

Modifier and Type	Method and Description
static Packet	borrowPacket(PacketType type, com.serotonin.util.queue.ByteQueue payload)
com.serotonin.util.queue.ByteQueue	getPayload()
PacketType	getType()
double	popDouble()
long	popLong()
java.lang.String	popString()
static void	pushDouble(com.serotonin.util.queue.ByteQueue queue, double d)
static void	pushLong(com.serotonin.util.queue.ByteQueue queue, long l)
static void	pushString(com.serotonin.util.queue.ByteQueue queue, java.lang.String s)
private static int	read4ByteSigned(java.io.InputStream in)
static Packet	readPacket(java.io.InputStream in, int version)
static Packet	readPacketNoBlock(java.io.InputStream in, int version)
private static void	readPayload(java.io.InputStream in, Packet packet, int length) Data may be getting sent very regularly from the publisher, so if there is corruption in the stream an SO timeout may not get thrown.
void	release()
private static void	write4ByteSigned(java.io.OutputStream out, int i)
private static void	writeHeader(java.io.OutputStream out, int version, PacketType type, int length)
static void	writePacket(java.io.OutputStream out, int version, Packet packet)
static void	writePacket(java.io.OutputStream out, int version, PacketType type, byte[] payload)
static void	writePacket(java.io.OutputStream out, int version, PacketType type, com.serotonin.util.queue.ByteQueue payload)

Methods inherited from class java.lang.Object

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

Field Detail

PUBLISHER_SOCKET_TIMEOUT

public static final int PUBLISHER_SOCKET_TIMEOUT

See Also:

Constant Field Values

DATA_SOURCE_SOCKET_TIMEOUT

public static final int DATA_SOURCE_SOCKET_TIMEOUT

See Also:

Constant Field Values

TEST_PACKET_SEND_DELAY

public static final int TEST_PACKET_SEND_DELAY

See Also:

Constant Field Values

PAYLOAD_READ_TIMEOUT

private static final int PAYLOAD_READ_TIMEOUT

See Also:

Constant Field Values

PAYLOAD_READ_BUFFER

private static final byte[] PAYLOAD_READ_BUFFER

CHARSET

private static final java.nio.charset.Charset CHARSET

EMPTY

public static final byte[] EMPTY

packetPool

static final org.apache.commons.pool.ObjectPool packetPool

type

private PacketType type

payload

private final com.serotonin.util.queue.ByteQueue payload

Constructor Detail

Packet

public Packet()

Method Detail

borrowPacket

public static Packet borrowPacket(PacketType type,
                                  com.serotonin.util.queue.ByteQueue payload)

readPacketNoBlock

public static Packet readPacketNoBlock(java.io.InputStream in,
                                       int version)
                                throws java.io.IOException,
                                       PersistentAbortException,
                                       PersistentProtocolException

Throws:

java.io.IOException

PersistentAbortException

PersistentProtocolException

readPacket

public static Packet readPacket(java.io.InputStream in,
                                int version)
                         throws java.io.IOException,
                                PersistentAbortException,
                                PersistentProtocolException

Throws:

java.io.IOException

PersistentAbortException

PersistentProtocolException

readPayload

private static void readPayload(java.io.InputStream in,
                                Packet packet,
                                int length)
                         throws java.io.IOException,
                                PayloadReadTimeoutException

Data may be getting sent very regularly from the publisher, so if there is corruption in the stream an SO timeout may not get thrown. Having a payload read timeout ensures that unusually long read times - such as when the length is suspiciously long - don't cause the communication to cease up, at least not for very long.

Parameters:

in - the socket input stream

packet - the packet we're trying to read

length - the length of the payload to read

Throws:

java.io.IOException - if a read error occurs, including an SO timeout

PayloadReadTimeoutException - if a payload read timeout occurs

writePacket

public static void writePacket(java.io.OutputStream out,
                               int version,
                               Packet packet)
                        throws java.io.IOException

Throws:

java.io.IOException

writePacket

public static void writePacket(java.io.OutputStream out,
                               int version,
                               PacketType type,
                               byte[] payload)
                        throws java.io.IOException

Throws:

java.io.IOException

writePacket

public static void writePacket(java.io.OutputStream out,
                               int version,
                               PacketType type,
                               com.serotonin.util.queue.ByteQueue payload)
                        throws java.io.IOException

Throws:

java.io.IOException

writeHeader

private static void writeHeader(java.io.OutputStream out,
                                int version,
                                PacketType type,
                                int length)
                         throws java.io.IOException

Throws:

java.io.IOException

pushString

public static void pushString(com.serotonin.util.queue.ByteQueue queue,
                              java.lang.String s)

pushLong

public static void pushLong(com.serotonin.util.queue.ByteQueue queue,
                            long l)

pushDouble

public static void pushDouble(com.serotonin.util.queue.ByteQueue queue,
                              double d)

write4ByteSigned

private static void write4ByteSigned(java.io.OutputStream out,
                                     int i)
                              throws java.io.IOException

Throws:

java.io.IOException

read4ByteSigned

private static int read4ByteSigned(java.io.InputStream in)
                            throws java.io.IOException

Throws:

java.io.IOException

getType

public PacketType getType()

getPayload

public com.serotonin.util.queue.ByteQueue getPayload()

popString

public java.lang.String popString()

popLong

public long popLong()

popDouble

public double popDouble()

release

public void release()