com.neeve.pkt

Class PktFactory

java.lang.Object

com.neeve.root.RootObject

com.neeve.pkt.PktFactory

public final class PktFactory
extends RootObject

Factory class used to instantiate packets and packet bodies.

This class is a singleton class used to instantiate packets. Packets are classified by type. Type information is loaded at class load time from a deployment's default configuration repository and also can be registered by the user programattically.

Threading:

This packet factory is not safe for concurrent access by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PktFactory.PktType Stores packet type information.

Method Summary

Modifier and Type	Method and Description
PktPacket	createPacket(ByteBuffer buffer) Create a packet from its serialized form.
PktPacket	createPacket(ByteBuffer buffer, int offset, int length) Create a packet from its serialized form.
PktPacket	createPacket(int pktTypeId) Create a packet using a packet type id.
PktPacket	createPacket(IOBuffer buffer, int offset, int length, boolean wrap) Create a packet from its serialized form.
PktPacket	createPacket(long addr, int offset, int length) Create a packet from its serialized form.
PktPacket	createPacket(String pktTypeName) Create a packet using a packet type name.
PktBody	createPacketBody(int pktTypeId) Create a packet body using a packet type id
PktBody	createPacketBody(String pktTypeName) Create a packet body using the packet type name.
PktPacket	createPacketNonPooled(int pktTypeId) Create a packet using a packet type id.
static PktFactory	getInstance() Return the singleton packet factory instance
PktFactory.PktType	getPacketType(int pktTypeId) Get a packet type by packet type id.
PktFactory.PktType	getPacketType(String pktTypeName) Get a packet type by packet type name.
String	getPacketTypeNameFromId(int pktTypeId) Get the packet type name by id
void	registerPacketType(PktFactory.PktType pktType) Register a packet type with the factory.

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PktFactory getInstance()

Return the singleton packet factory instance

Returns:

Returns the packet factory

Threading:

This method is safe for concurrent access by multiple threads

registerPacketType

public final void registerPacketType(PktFactory.PktType pktType)

Register a packet type with the factory.

Throws:

IllegalArgumentException - Thrown in case the supplied packet type is null.

Threading:

This method is not safe for concurrent acces by multiple threads with itself or any other method in this class.

This method is supplied for programmatic registration of packet types with the packet factory. This method should be used with caution since the underlying packet type table is not managed in a thread safe manner and invoking this method while messaging is in progress can corrupt the table. The recommended practice is to register all packet types in the local configuration repository. The factory loads up all packet types in the local repository in its class constructor thus ensuring thread safe management of the type table. If this method is used to register packet types, the user must ensure it is done so before any messaging is started.

It is a fatal error to register a packet type with a duplicate name or id. Doing so will result in an {link hava.lang.Error} being thrown.

getPacketType

public final PktFactory.PktType getPacketType(int pktTypeId)

Get a packet type by packet type id.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

getPacketType

public final PktFactory.PktType getPacketType(String pktTypeName)

Get a packet type by packet type name.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

getPacketTypeNameFromId

public final String getPacketTypeNameFromId(int pktTypeId)

Get the packet type name by id

Parameters:

pktTypeId - The id for which to return the name

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacketBody

public final PktBody createPacketBody(int pktTypeId)
                               throws EPktTypeInvalidException,
                                      EPktBodyClassLoadException,
                                      EPktBodyClassInstantiateException,
                                      EPktException

Create a packet body using a packet type id

Parameters:

pktTypeId - The packet type id

Returns:

Returns the created packet body

Throws:

EPktTypeInvalidException - Thrown if the specified id is not a valid packet body type id.

EPktBodyClassLoadException - Thrown if a failure was encountered while loading the packet body class.

EPktBodyClassInstantiateException - Thrown if a failure was encountered while instantiating the packet body class.

EPktException - Thrown if any other exception was encountered while creating the new packet body.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacketBody

public final PktBody createPacketBody(String pktTypeName)
                               throws EPktTypeInvalidException,
                                      EPktBodyClassLoadException,
                                      EPktBodyClassInstantiateException,
                                      EPktException

Create a packet body using the packet type name.

Parameters:

pktTypeName - The packet type name

Returns:

Returns the created packet body

Throws:

EPktTypeInvalidException - Thrown if the specified name is not a valid packet type name.

EPktBodyClassLoadException - Thrown if a failure was encountered while loading the packet body class.

EPktBodyClassInstantiateException - Thrown if a failure was encountered while instantiating the packet body class.

EPktException - Thrown if any other exception was encountered while creating the new packet.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacket

public final PktPacket createPacket(int pktTypeId)
                             throws EPktTypeInvalidException,
                                    EPktBodyClassLoadException,
                                    EPktBodyClassInstantiateException,
                                    EPktException

Create a packet using a packet type id.

Parameters:

pktTypeId - The packet type id.

Returns:

Returns the created packet.

Throws:

EPktTypeInvalidException - Thrown if the specified id is not a valid packet body type id.

EPktBodyClassLoadException - Thrown if a failure was encountered while loading the packet body class.

EPktBodyClassInstantiateException - Thrown if a failure was encountered while instantiating the packet body class.

EPktException - Thrown if any other exception was encountered while creating the new packet.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacketNonPooled

public final PktPacket createPacketNonPooled(int pktTypeId)
                                      throws EPktTypeInvalidException,
                                             EPktBodyClassLoadException,
                                             EPktBodyClassInstantiateException,
                                             EPktException

Create a packet using a packet type id.

Parameters:

pktTypeId - The packet type id.

Returns:

Returns the created packet.

Throws:

EPktTypeInvalidException - Thrown if the specified id is not a valid packet body type id.

EPktBodyClassLoadException - Thrown if a failure was encountered while loading the packet body class.

EPktBodyClassInstantiateException - Thrown if a failure was encountered while instantiating the packet body class.

EPktException - Thrown if any other exception was encountered while creating the new packet.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

This method is identical to createPacket(int) except that the packet is always created fresh and not from the packet type's pool
NOTE: THIS METHOD IS INTENDED FOR X PLATFORM INTERNAL USE AND SHOULD NOT BE USED. PLEASE CONSULT NEEVE TECHNICAL SUPPORT BEFORE YOU USE THIS METHOD. THIS METHOD CAN BE DEPRECATED/REMOVED/CHANGED AT ANY TIME WIHOUT NOTICE

createPacket

public final PktPacket createPacket(String pktTypeName)
                             throws EPktTypeInvalidException,
                                    EPktBodyClassLoadException,
                                    EPktBodyClassInstantiateException,
                                    EPktException

Create a packet using a packet type name.

Parameters:

pktTypeName - The packet type name.

Returns:

Returns the created packet

Throws:

EPktTypeInvalidException - Thrown if the specified name is not a valid packet type name.

EPktBodyClassLoadException - Thrown if a failure was encountered while loading the packet body class.

EPktBodyClassInstantiateException - Thrown if a failure was encountered while instantiating the packet body class.

EPktException - Thrown if any other exception was encountered while creating the new packet.

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacket

public final PktPacket createPacket(ByteBuffer buffer,
                                    int offset,
                                    int length)

Create a packet from its serialized form.

Parameters:

buffer - The buffer that contains the serialized packet.

offset - The offset into the buffer where the serialized packet starts.

length - The number of valid bytes in buffer. The number of bytes must be greater or equal to the length of the serialized packet. Otherwise, this method will throw an EPktIncompleteException.

Returns:

Returns the created packet

Throws:

EPktCorruptException - Thrown if a valid packet does not start at the specified offset in the buffer

EPktVersionInvalidException - Thrown in case the buffer contains a serialized packet with an invalid header format version

EPktIncompleteException - Thrown if the number of valid bytes in the supplied buffer does not form a complete packet

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacket

public final PktPacket createPacket(ByteBuffer buffer)

Create a packet from its serialized form.

This method invokes createPacket(buffer, buffer.position(), buffer.remaining())

createPacket

public final PktPacket createPacket(IOBuffer buffer,
                                    int offset,
                                    int length,
                                    boolean wrap)

Create a packet from its serialized form.

Parameters:

buffer - The buffer that contains the serialized packet.

offset - The offset into the buffer where the serialized packet starts.

length - The number of valid bytes in buffer. The number of bytes must be greater or equal to the length of the serialized packet. Otherwise, this method will throw an EPktIncompleteException.

wrap - Indicates whether the new packet should copy its contents from the supplied buffer to the packet header or wrap the packet around the supplied buffer

Returns:

Returns the created packet

Throws:

EPktCorruptException - Thrown if a valid packet does not start at the specified offset in the buffer

EPktVersionInvalidException - Thrown in case the buffer contains a serialized packet with an invalid header format version

EPktIncompleteException - Thrown if the number of valid bytes in the supplied buffer does not form a complete packet

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).

createPacket

public final PktPacket createPacket(long addr,
                                    int offset,
                                    int length)

Create a packet from its serialized form.

Parameters:

addr - The address of the memory region that contains the serialized packet.

offset - The offset into the buffer where the serialized packet starts.

length - The number of valid bytes in buffer. The number of bytes must be greater or equal to the length of the serialized packet. Otherwise, this method will throw an EPktIncompleteException.

Returns:

Returns the created packet

Throws:

EPktCorruptException - Thrown if a valid packet does not start at the specified offset in the buffer

EPktVersionInvalidException - Thrown in case the buffer contains a serialized packet with an invalid header format version

EPktIncompleteException - Thrown if the number of valid bytes in the supplied buffer does not form a complete packet

Threading:

This method is safe for concurrent access by multiple threads with itself and all other methods except for registerPacketType(com.neeve.pkt.PktFactory.PktType, boolean).