com.neeve.pkt

Class PktBody

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.pkt.PktBody

All Implemented Interfaces:

IOElasticBuffer.Initializer, IOElasticBuffer.Sizer

Direct Known Subclasses:

PktBodyFixed, PktBodyVariable, PktSubheader

public abstract class PktBody
extends UtlListElement
implements IOElasticBuffer.Sizer, IOElasticBuffer.Initializer

Base class for all packet bodies.

Threading:

Packet bodies are not safe for concurrent access by multiple threads.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Modifier and Type	Method and Description
void	deserialize(byte[] array, int arrayOffset, int length) Deserialize a packet body from a byte array This method invokes putFrom(array, arrayOffset, length).desync()
void	deserialize(ByteBuffer buf, int length) Deserialize a packet body from a byte buffer This method invokes deserialize(buf, buf.position(), length)
void	deserialize(ByteBuffer buf, int bufOffset, int length) Deserialize a packet body from a byte buffer This method invokes putFrom(buf, bufOffset, length).desync()
void	deserialize(IOBuffer iobuf, int iobufOffset, int length) Deserialize a packet body from an IO buffer This method invokes deserialize(iobuf, iobufOffset, length, false).desync()
void	deserialize(IOBuffer iobuf, int iobufOffset, int length, boolean wrap) Deserialize a packet body from an IO buffer This method invokes putFrom(iobuf, iobufOffset, length, wrap).desync()
void	deserialize(IOElasticBuffer iobuf, int iobufOffset, int length) Deserialize a packet body from an elastic IO buffer This method invokes deserialize(iobuf, iobufOffset, length).desync()
void	deserialize(long addr, int addrOffset, int length) Deserialize a packet body from a native memory region This method invokes deserialize(addr, addrOffset, length).desync()
void	desync() Desync the early desync contents of a packet body's backing buffer
String	dump(String prefix) Dump the contents of a packet body
IOElasticBuffer	getBuffer() Get the backing buffer
int	getInitialBufferLength() Implementation of IOElasticBuffer.Sizer.getInitialBufferLength()
int	getSerializedLength() Get the serialized length of a packet body
int	getTo(byte[] array) Copy the contents of a packet body's backing buffer to a byte array This method invokes return getTo(array, 0)
int	getTo(byte[] array, int arrayOffset) Copy the contents of a packet body's backing buffer to a byte array
int	getTo(ByteBuffer buf) Copy the contents of a packet body's backing buffer to a byte buffer This method invokes return getTo(buf, buf.position())
int	getTo(ByteBuffer buf, int bufOffset) Copy the contents of a packet body's backing buffer to a byte buffer
int	getTo(IOBuffer iobuf, int iobufOffset) Copy the contents of a packet body's backing buffer to an IOBuffer
int	getTo(IOElasticBuffer iobuf, int iobufOffset) Copy the contents of a packet body's backing buffer to an IOElasticBuffer
int	getTo(long addr, int addrOffset) Copy the contents of a packet body's backing buffer to a native memory region
int	getType() Get the body type
void	initializeBuffer() Implementation of IOElasticBuffer.Initializer.initializeBuffer() The default implementation of this method is no-op.
PktBody	putFrom(byte[] array, int arrayOffset, int length) Copy the contents of a packet body's backing buffer from a byte array
PktBody	putFrom(ByteBuffer buf, int length) Copy the contents of a packet body's backing buffer from a byte buffer This method invokes putFrom(buf, buf.position(), length)
PktBody	putFrom(ByteBuffer buf, int bufOffset, int length) Copy the contents of a packet body's backing buffer from a byte buffer
PktBody	putFrom(IOBuffer iobuf, int iobufOffset, int length) Copy the contents of a packet body's backing buffer from an IOBuffer This method invokes putFrom(iobuf, iobufOffset, length, false)
PktBody	putFrom(IOBuffer iobuf, int iobufOffset, int length, boolean wrap) Copy the contents of a packet body's backing buffer from an IOBuffer
PktBody	putFrom(IOElasticBuffer iobuf, int iobufOffset, int length) Copy the contents of a packet body's backing buffer from an IOElasticBuffer
PktBody	putFrom(long addr, int addrOffset, int length) Copy the contents of a packet body's backing buffer from a native memory region
PktBody	putFrom(PktBody src) Copy a packet body from another packet body
void	reset() Reset the body contents This method invokes reset(true)
void	reset(boolean initBackingBuffer) Reset the body contents
int	serialize(byte[] array, int arrayOffset) Serialize a packet body to a byte array This method invokes syncf().getTo(buf, bufOffset)
int	serialize(ByteBuffer buf) Serialize a packet body to a byte buffer This method invokes serialize(buf, buf.position())
int	serialize(ByteBuffer buf, int bufOffset) Serialize a packet body to a byte buffer This method invokes syncf().getTo(buf, bufOffset)
int	serialize(IOBuffer iobuf, int iobufOffset) Serialize a packet body to an IO buffer This method invokes syncf().getTo(iobuf, iobufOffset)
int	serialize(IOElasticBuffer iobuf, int iobufOffset) Serialize a packet body to an elastic IO buffer This method invokes syncf().getTo(iobuf, iobufOffset)
int	serialize(long addr, int addrOffset) Serialize a packet body to a native memory region This method invokes syncf().getTo(addr, addrOffset)
int	sync() Sync a packets body contents to the body's backing buffer
PktBody	syncf() Sync method for use with fluent programming

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

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

Method Detail

getType

public final int getType()

Get the body type

getBuffer

public final IOElasticBuffer getBuffer()

Get the backing buffer

reset

public final void reset(boolean initBackingBuffer)

Reset the body contents

Parameters:

initializeBuffer - Whether to wipe and initialize the backing buffer

This method resets the contents of a packet body.

reset

public final void reset()

Reset the body contents

This method invokes reset(true)

getSerializedLength

public final int getSerializedLength()

Get the serialized length of a packet body

sync

public final int sync()

Sync a packets body contents to the body's backing buffer

Returns:

Returns the length of the serialized contents

Invoking this method ensures that a packet body is fully serialized to it backing buffer and can be copied out

syncf

public final PktBody syncf()

Sync method for use with fluent programming

Returns:

Return this instance for fluent invocation chaining

This method is the same as sync() except it return this object instead of length for fluent invocation chaining

desync

public final void desync()

Desync the early desync contents of a packet body's backing buffer

getTo

public final int getTo(ByteBuffer buf,
                       int bufOffset)

Copy the contents of a packet body's backing buffer to a byte buffer

Parameters:

buf - The byte buffer to copy to

bufOffset - The offset into the buffer where the serialized contents of the packet body needs to be copied

Returns:

length The number of bytes copied

This method copies the contents of a packet body to a byte buffer. It copies the contents to the target buffer starting at the supplied buffer offset. This method does not change any of the markers of the target byte buffer.

Note:Since this method does not change any markers of the target buffer, the caller needs to ensure the buffer has enough capacity to accommodate the body's contents. The caller can invoke getSerializedLength() to get the length of the body's contents and use that to set the target buffer's capacity before invoking this method. Note:This method does not invoke sync() before doing the copy. The caller needs to ensure that sync() is invoked prior to invoking this method.

getTo

public final int getTo(ByteBuffer buf)

Copy the contents of a packet body's backing buffer to a byte buffer

This method invokes return getTo(buf, buf.position())

getTo

public final int getTo(byte[] array,
                       int arrayOffset)

Copy the contents of a packet body's backing buffer to a byte array

Parameters:

array - The byte array to copy to

arrayOffset - The offset into the array where the serialized contents of the packet body needs to be copied

Returns:

length The number of bytes copied

This method copies the contents of a packet body to a byte array.

Note:The caller needs to ensure the target array has enough capacity to accommodate the body's contents. The caller can invoke getSerializedLength() to get the length of the body's contents and use that to set the target array's capacity before invoking this method. Note:This method does not invoke sync() before doing the copy. The caller needs to ensure that sync() is invoked prior to invoking this method.

getTo

public final int getTo(byte[] array)

Copy the contents of a packet body's backing buffer to a byte array

This method invokes return getTo(array, 0)

getTo

public final int getTo(IOBuffer iobuf,
                       int iobufOffset)

Copy the contents of a packet body's backing buffer to an IOBuffer

Parameters:

iobuf - The IO buffer to copy to

iobufOffset - The offset into the IO buffer where the serialized contents of the packet body needs to be copied

Returns:

length The number of bytes copied

This method copies the contents of a packet body to an IO buffer.

Note:The caller needs to ensure the target buffer has enough capacity to accommodate the body's serialized contents. The caller can invoke the getSerializedLength() method to get the length of the body's contents to ensure the target buffer is sized correctly Note:This method does not invoke sync() before doing the copy. The caller needs to ensure that sync() is invoked prior to invoking this method.

getTo

public final int getTo(IOElasticBuffer iobuf,
                       int iobufOffset)

Copy the contents of a packet body's backing buffer to an IOElasticBuffer

Parameters:

iobuf - The IO buffer to copy to

iobufOffset - The offset into the IO buffer where the serialized contents of the packet body needs to be copied

Returns:

length The number of bytes copied

This method copies the contents of a packet body to an IOelasticBuffer

Note:This method does not invoke sync() before doing the copy. The caller needs to ensure that sync() is invoked prior to invoking this method.

getTo

public final int getTo(long addr,
                       int addrOffset)

Copy the contents of a packet body's backing buffer to a native memory region

Parameters:

addr - The address of the native memory region to copy to

addrOffset - The offset into the memory region where the serialized contents of the packet body should be copied to.

Returns:

length The number of bytes copied

This method copies the contents of a packet body to a native memory region.

Note:The caller needs to ensure the target memory region has enough capacity to accommodate the header's serialized contents. The caller can invoke the getSerializedLength() method to get the length of the header's contents to ensure the target region is sized correctly Note:This method does not invoke sync() before doing the copy. The caller needs to ensure that sync() is invoked prior to invoking this method.

putFrom

public final PktBody putFrom(ByteBuffer buf,
                             int bufOffset,
                             int length)

Copy the contents of a packet body's backing buffer from a byte buffer

Parameters:

buf - The byte buffer to copy from

length - The length of the body's serialized contents

Returns:

Returns this object for invocation chaining.

This method copies the contents of a packet body from a byte buffer to the packet body's buffer. It does not change any of the markers of the source byte buffer

putFrom

public final PktBody putFrom(ByteBuffer buf,
                             int length)

Copy the contents of a packet body's backing buffer from a byte buffer

This method invokes putFrom(buf, buf.position(), length)

putFrom

public final PktBody putFrom(byte[] array,
                             int arrayOffset,
                             int length)

Copy the contents of a packet body's backing buffer from a byte array

Parameters:

array - The byte array to copy from

arrayOffset - The offset into the array where the serialized contents of the packet body begins.

length - The length of the body's serialized contents

Returns:

Returns this object for invocation chaining.

This method copies the contents of a packet from a byte array to the packet body's buffer.

putFrom

public final PktBody putFrom(IOBuffer iobuf,
                             int iobufOffset,
                             int length,
                             boolean wrap)

Copy the contents of a packet body's backing buffer from an IOBuffer

Parameters:

iobuf - The IO buffer to copy from

iobufOffset - The offset into the IO buffer where the serialized contents of the packet body begins.

length - The length of the body's serialized contents

wrap - Indicates whether this method should copy the contents of the IO buffer to the packet body or wrap the packet body's buffer around the supplied IO buffer

Returns:

Returns this object for invocation chaining.

This method copies the contents from an IOBuffer to the packet body's buffer.

putFrom

public final PktBody putFrom(IOBuffer iobuf,
                             int iobufOffset,
                             int length)

Copy the contents of a packet body's backing buffer from an IOBuffer

This method invokes putFrom(iobuf, iobufOffset, length, false)

putFrom

public final PktBody putFrom(IOElasticBuffer iobuf,
                             int iobufOffset,
                             int length)

Copy the contents of a packet body's backing buffer from an IOElasticBuffer

Parameters:

iobuf - The IO buffer to copy from

iobufOffset - The offset into the IO buffer where the serialized contents of the packet body begins.

length - The length of the body's serialized contents

Returns:

Returns this object for invocation chaining.

This method copies the contents from an IOElasticBufferto the packet body's buffer.

putFrom

public final PktBody putFrom(long addr,
                             int addrOffset,
                             int length)

Copy the contents of a packet body's backing buffer from a native memory region

Parameters:

addr - The address of the native memory region to copy from

addrOffset - The offset into the memory region where the serialized contents of the packet body begins.

length - The length of the body's serialized contents

Returns:

Returns this object for invocation chaining.

This method copies the contents from a native memory region to the packet body's buffer.

putFrom

public final PktBody putFrom(PktBody src)

Copy a packet body from another packet body

Returns:

Returns this object for invocation chaining.

Note: This method assumes that the source body is already sync'd

serialize

public final int serialize(ByteBuffer buf)

Serialize a packet body to a byte buffer

This method invokes serialize(buf, buf.position())

serialize

public final int serialize(ByteBuffer buf,
                           int bufOffset)

Serialize a packet body to a byte buffer

This method invokes syncf().getTo(buf, bufOffset)

serialize

public final int serialize(byte[] array,
                           int arrayOffset)

Serialize a packet body to a byte array

This method invokes syncf().getTo(buf, bufOffset)

serialize

public final int serialize(IOBuffer iobuf,
                           int iobufOffset)

Serialize a packet body to an IO buffer

This method invokes syncf().getTo(iobuf, iobufOffset)

serialize

public final int serialize(IOElasticBuffer iobuf,
                           int iobufOffset)

Serialize a packet body to an elastic IO buffer

This method invokes syncf().getTo(iobuf, iobufOffset)

serialize

public final int serialize(long addr,
                           int addrOffset)

Serialize a packet body to a native memory region

This method invokes syncf().getTo(addr, addrOffset)

deserialize

public final void deserialize(ByteBuffer buf,
                              int length)

Deserialize a packet body from a byte buffer

This method invokes deserialize(buf, buf.position(), length)

deserialize

public final void deserialize(ByteBuffer buf,
                              int bufOffset,
                              int length)

Deserialize a packet body from a byte buffer

This method invokes putFrom(buf, bufOffset, length).desync()

deserialize

public final void deserialize(byte[] array,
                              int arrayOffset,
                              int length)

Deserialize a packet body from a byte array

This method invokes putFrom(array, arrayOffset, length).desync()

deserialize

public final void deserialize(IOBuffer iobuf,
                              int iobufOffset,
                              int length,
                              boolean wrap)

Deserialize a packet body from an IO buffer

This method invokes putFrom(iobuf, iobufOffset, length, wrap).desync()

deserialize

public final void deserialize(IOBuffer iobuf,
                              int iobufOffset,
                              int length)

Deserialize a packet body from an IO buffer

This method invokes deserialize(iobuf, iobufOffset, length, false).desync()

deserialize

public final void deserialize(IOElasticBuffer iobuf,
                              int iobufOffset,
                              int length)

Deserialize a packet body from an elastic IO buffer

This method invokes deserialize(iobuf, iobufOffset, length).desync()

deserialize

public final void deserialize(long addr,
                              int addrOffset,
                              int length)

Deserialize a packet body from a native memory region

This method invokes deserialize(addr, addrOffset, length).desync()

dump

public final String dump(String prefix)

Dump the contents of a packet body

getInitialBufferLength

public final int getInitialBufferLength()

Implementation of IOElasticBuffer.Sizer.getInitialBufferLength()

Specified by:

getInitialBufferLength in interface IOElasticBuffer.Sizer

Returns:

Returns length of the backing buffer if the body was intiatiated via a partial deserialized or length returned by doGetInitialBufferLength() otherwise

initializeBuffer

public void initializeBuffer()

Implementation of IOElasticBuffer.Initializer.initializeBuffer()

The default implementation of this method is no-op. The concrete body implementation should override and implement this method if it needs to do buffer initialization.

Specified by:

initializeBuffer in interface IOElasticBuffer.Initializer