com.neeve.pkt
Class PktSubheaderODS

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.pkt.PktSerializable
          com.neeve.pkt.PktBody
              com.neeve.pkt.PktSubheader
                  com.neeve.pkt.PktSubheaderVariable
                      com.neeve.pkt.PktSubheaderODS

All Implemented Interfaces:

PktBuffer.Initializer

public final class PktSubheaderODS
extends PktSubheaderVariable

The ODS packet subheader.

This class is the subheader used by ODS Neeve store binding to tunnel control information.

This packet subheader header is a versioned entity. The subheader version defines the format of the subheader i.e. what fields comprise the subheader and their relative locations when serialized. A crucial aspect of subheader versioning is that a version N subheader will always be a subset of a version M subheader where N < M i.e. all fields in version N of a subheader will be present and in the same position as fields in version M of the subheader. i.e. a subheader never shrinks or moves fields around. With time, the subheader can only grow. See the setter/getter method documentation for information on which subheader version the fields that they affect belong to.

Threading:

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

Nested Class Summary

Nested classes/interfaces inherited from class com.neeve.pkt.PktSerializable

PktSerializable.DeserializeContext, PktSerializable.SerializeContext

Field Summary

static int	FLAG_COMMIT_ACK_REQUIRED Specifies that a commit ack needs to be sent back
static int	FLAG_COMMIT_END Specifies the end of a commit batch
static int	FLAG_COMMIT_ENTRY_IN_INIT Specifies that the commit entry is part of an init
static int	FLAG_COMMIT_ENTRY_IS_PUT Specifies that the commit entry is for a put
static int	FLAG_COMMIT_ENTRY_IS_REMOVE Specifies that the commit entry is for a remove
static int	FLAG_COMMIT_ENTRY_IS_SEND Specifies that the commit entry is for a send
static int	FLAG_COMMIT_ENTRY_IS_UPDATE Specifies that the commit entry is for an update
static int	FLAG_COMMIT_START Specifies the beginning of a commit batch

Fields inherited from class com.neeve.pkt.PktSubheader

PREAMBLE_LENGTH, PREAMBLE_LENGTH_V1

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

void	copyObjectMetadataFrom(PktBuffer metadata) Copy the object metadata (V1 Subheader Field) from a packet buffer.
void	copyObjectMetadataTo(PktBuffer buffer, int offset) Copy the object metadata (V1 Subheader Field) to a packet buffer.
void	copyPersisterMetadataFrom(PktBuffer metadata) Copy the persister metadata (V1 Subheader Field) from a packet buffer.
void	copyPersisterMetadataTo(PktBuffer buffer, int offset) Copy the persister metadata (V1 Subheader Field) to a packet buffer.
static PktBody	create() Creates a default ODS subheader
static PktBody	create(Properties props) Creates an ODS subheader
int	doGetSerializedLength() Implementation of PktBody.doGetSerializedLength()
long	getCheckpointVersion() Get the checkpoint version (V1 Subheader Field).
short	getContentEncodingType() Get the contentEncodingType type(V1 Subheader Field).
long	getCurrentCommitSno() Get the current commit sequence number (V1 Subheader Field).
boolean	getFlagCommitAckRequired() Get the 'commit ack required' flag (V1 Subheader Field).
boolean	getFlagCommitEnd() Get the 'commit end' flag (V1 Subheader Field).
boolean	getFlagCommitEntryInInit() Get the 'commit entry in INIT' flag (V1 Subheader Field).
boolean	getFlagCommitEntryIsPut() Get the 'commit entry is PUT' flag (V1 Subheader Field).
boolean	getFlagCommitEntryIsRemove() Get the 'commit entry is REMOVE' flag (V1 Subheader Field).
boolean	getFlagCommitEntryIsSend() Get the 'commit entry is SEND' flag (V1 Subheader Field).
boolean	getFlagCommitEntryIsUpdate() Get the 'commit entry is UPDATE' flag (V1 Subheader Field).
boolean	getFlagCommitStart() Get the 'commit start' flag (V1 Subheader Field).
int	getFlags() Get the flags (V1 Subheader Field).
static short	getLatestSubheaderVersion() Get the latest subheader version.
long	getLeaderRound() Get the leader round (V1 Subheader Field).
short	getObjectFactoryId() Get the object factory id (V1 Subheader Field).
com.eaio.uuid.UUID	getObjectId() Get the object id (V1 Subheader Field).
PktBuffer	getObjectMetadata() Get the object metadata (V1 Subheader Field).
short	getObjectType() Get the object type (V1 Subheader Field).
PktBuffer	getPersisterMetadata() Get the persister metadata (V1 Subheader Field).
int	getSerializedLength(ByteBuffer buffer) Implementation of PktSubheader.getSerializedLength(ByteBuffer)
long	getStableCommitSno() Get the stable commit sequence number (V1 Subheader Field).
long	getStableTransactionId() Get the stable transactionId (V1 Subheader Field).
short	getSubheaderVersion() Get the header format version (V1 Subheader Field).
long	getTransactionId() Get the transactionId (V1 Subheader Field).
void	initialize() Implementation of PktBody.initialize()
void	initializeBuffer() Implementation of PktBuffer.Initializer.initializeBuffer()
static void	prepare(PktPacket packet, long round, long currCommitSno, long stblCommitSno, com.eaio.uuid.UUID objectId, short contentEncoding, long transactionId, long stableTransactionId, long checkpointVersion, short ofid, short otype, int flags) Prepare a packet with an ODS subheader with latest version.
void	setCheckpointVersion(long checkpointVersion) Set the checkpoint version (V1 Subheader Field).
void	setContentEncodingType(short contentEncodingType) Set the contentEncodingType type (V1 Subheader Field).
void	setCurrentCommitSno(long currCommitSno) Set the current commit sequence number (V1 Subheader Field).
void	setFlagCommitAckRequired(boolean val) Set the 'commit ack required' flag
void	setFlagCommitEnd(boolean val) Set the 'commit end' flag (V1 Subheader Field).
void	setFlagCommitEntryInInit(boolean val) Set the 'commit entry in INIT' flag
void	setFlagCommitEntryIsPut(boolean val) Set the 'commit entry is PUT' flag
void	setFlagCommitEntryIsRemove(boolean val) Set the 'commit entry is REMOVE' flag
void	setFlagCommitEntryIsSend(boolean val) Set the 'commit entry is SEND' flag
void	setFlagCommitEntryIsUpdate(boolean val) Set the 'commit entry is UPDATE' flag
void	setFlagCommitStart(boolean val) Set the 'commit start' flag
void	setFlags(int flags) Set the flags (V1 Subheader Field).
void	setLeaderRound(long round) Set the leader round (V1 Subheader Field).
void	setObjectFactoryId(short ofid) Set the object factory id (V1 Subheader Field).
void	setObjectId(com.eaio.uuid.UUID objectId) Set the object id (V1 Subheader Field).
void	setObjectType(short otype) Set the object type (V1 Subheader Field).
void	setStableCommitSno(long stblCommitSno) Set the stable commit sequence number (V1 Subheader Field).
void	setStableTransactionId(long stableTransactionId) Set the stable transaction id (V1 Subheader Field).
void	setTransactionId(long transactionId) Set the transaction id (V1 Subheader Field).
String	toString() Returns a string representation of the object

Methods inherited from class com.neeve.pkt.PktSubheader

getType

Methods inherited from class com.neeve.pkt.PktBody

deserialize, getBuffer, getSerializedLength, getType, isNative, reset, serialize

Methods inherited from class com.neeve.pkt.PktSerializable

deserialize, getDeserializationPolicy, getSerializationPolicy, isValidDeserializationPolicy, isValidSerializationPolicy, serialize, setDeserializationPolicy, setSerializationPolicy

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, wait, wait, wait

Field Detail

FLAG_COMMIT_START

public static final int FLAG_COMMIT_START

Specifies the beginning of a commit batch

See Also:

Constant Field Values

FLAG_COMMIT_END

public static final int FLAG_COMMIT_END

Specifies the end of a commit batch

See Also:

Constant Field Values

FLAG_COMMIT_ACK_REQUIRED

public static final int FLAG_COMMIT_ACK_REQUIRED

Specifies that a commit ack needs to be sent back

See Also:

Constant Field Values

FLAG_COMMIT_ENTRY_IS_PUT

public static final int FLAG_COMMIT_ENTRY_IS_PUT

Specifies that the commit entry is for a put

See Also:

Constant Field Values

FLAG_COMMIT_ENTRY_IS_UPDATE

public static final int FLAG_COMMIT_ENTRY_IS_UPDATE

Specifies that the commit entry is for an update

See Also:

Constant Field Values

FLAG_COMMIT_ENTRY_IS_REMOVE

public static final int FLAG_COMMIT_ENTRY_IS_REMOVE

Specifies that the commit entry is for a remove

See Also:

Constant Field Values

FLAG_COMMIT_ENTRY_IS_SEND

public static final int FLAG_COMMIT_ENTRY_IS_SEND

Specifies that the commit entry is for a send

See Also:

Constant Field Values

FLAG_COMMIT_ENTRY_IN_INIT

public static final int FLAG_COMMIT_ENTRY_IN_INIT

Specifies that the commit entry is part of an init

See Also:

Constant Field Values

Method Detail

create

public static PktBody create(Properties props)

Creates an ODS subheader

Parameters:

props - The property set to use to qualify creation of the body.

create

public static PktBody create()

Creates a default ODS subheader

prepare

public static void prepare(PktPacket packet,
                           long round,
                           long currCommitSno,
                           long stblCommitSno,
                           com.eaio.uuid.UUID objectId,
                           short contentEncoding,
                           long transactionId,
                           long stableTransactionId,
                           long checkpointVersion,
                           short ofid,
                           short otype,
                           int flags)

Prepare a packet with an ODS subheader with latest version.

Parameters:

packet - The packet to prepare.

round - The leader round to set

currCommitSno - The current commit sequence number to set.

stblCommitSno - The stable commit sequence number to set.

objectId - The object id to set.

contentEncoding - The object's content encoding.

transactionId - The current transaction id.

stableTransactionId - The stable transaction id.

checkpointVersion - The checkpoint version.

ofid - The object's factory id.

otype - The object's type.

flags - The flags to set.

Threading:

This method is not safe for concurrent access by multiple threads on the same request and reply.

getLatestSubheaderVersion

public static final short getLatestSubheaderVersion()

Get the latest subheader version.

This method returns the latest subheader version i.e. the version used when subheaders are created explicitly i.e. not through deserialization

Threading:

This method is safe for concurrent access by multiple threads

initialize

public final void initialize()

Implementation of PktBody.initialize()

doGetSerializedLength

public final int doGetSerializedLength()

Implementation of PktBody.doGetSerializedLength()

getSerializedLength

public final int getSerializedLength(ByteBuffer buffer)

Implementation of PktSubheader.getSerializedLength(ByteBuffer)

Specified by:

getSerializedLength in class PktSubheader

getSubheaderVersion

public final short getSubheaderVersion()

Get the header format version (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setLeaderRound

public final void setLeaderRound(long round)

Set the leader round (V1 Subheader Field).

Parameters:

round - The round to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getLeaderRound

public final long getLeaderRound()

Get the leader round (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setCurrentCommitSno

public final void setCurrentCommitSno(long currCommitSno)

Set the current commit sequence number (V1 Subheader Field).

Parameters:

currCommitSno - The commit sequence number to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getCurrentCommitSno

public final long getCurrentCommitSno()

Get the current commit sequence number (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setStableCommitSno

public final void setStableCommitSno(long stblCommitSno)

Set the stable commit sequence number (V1 Subheader Field).

Parameters:

stblCommitSno - The commit sequence number to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getStableCommitSno

public final long getStableCommitSno()

Get the stable commit sequence number (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setObjectId

public final void setObjectId(com.eaio.uuid.UUID objectId)

Set the object id (V1 Subheader Field).

Parameters:

objectId - The object id to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getObjectId

public final com.eaio.uuid.UUID getObjectId()

Get the object id (V1 Subheader Field).

NOTE:
If the packet that this header belongs to is pooled, the validity of the returned UUID is only valid while the packet remains, undisposed. Once the object is returned to its pool the UUID may be wiped and reused. Consequently, callers that plan to use the returned id beyond this objects lifespan should either make a copy of it, or aquire this object to prevent it from be returned to its pool.

Threading:

This method is not safe for concurrent access by multiple threads.

setObjectFactoryId

public final void setObjectFactoryId(short ofid)

Set the object factory id (V1 Subheader Field).

Parameters:

ofid - The object factory id to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getObjectFactoryId

public final short getObjectFactoryId()

Get the object factory id (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setObjectType

public final void setObjectType(short otype)

Set the object type (V1 Subheader Field).

Parameters:

otype - The object type to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getObjectType

public final short getObjectType()

Get the object type (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setContentEncodingType

public final void setContentEncodingType(short contentEncodingType)

Set the contentEncodingType type (V1 Subheader Field).

Parameters:

contentEncodingType - The encoding type to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getContentEncodingType

public final short getContentEncodingType()

Get the contentEncodingType type(V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setTransactionId

public final void setTransactionId(long transactionId)

Set the transaction id (V1 Subheader Field).

Parameters:

transactionId - The transaction id to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getTransactionId

public final long getTransactionId()

Get the transactionId (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setStableTransactionId

public final void setStableTransactionId(long stableTransactionId)

Set the stable transaction id (V1 Subheader Field).

Parameters:

stableTransactionId - The stable transaction id to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getStableTransactionId

public final long getStableTransactionId()

Get the stable transactionId (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setCheckpointVersion

public final void setCheckpointVersion(long checkpointVersion)

Set the checkpoint version (V1 Subheader Field).

Parameters:

checkpointVersion - The checkpointVersion to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getCheckpointVersion

public final long getCheckpointVersion()

Get the checkpoint version (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setFlags

public final void setFlags(int flags)

Set the flags (V1 Subheader Field).

Parameters:

flags - The flags to set.

Threading:

This method is not safe for concurrent access by multiple threads.

getFlags

public final int getFlags()

Get the flags (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads.

setFlagCommitStart

public final void setFlagCommitStart(boolean val)

Set the 'commit start' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitStart

public final boolean getFlagCommitStart()

Get the 'commit start' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitEnd

public final void setFlagCommitEnd(boolean val)

Set the 'commit end' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitEnd

public final boolean getFlagCommitEnd()

Get the 'commit end' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitAckRequired

public final void setFlagCommitAckRequired(boolean val)

Set the 'commit ack required' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitAckRequired

public final boolean getFlagCommitAckRequired()

Get the 'commit ack required' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitEntryIsPut

public final void setFlagCommitEntryIsPut(boolean val)

Set the 'commit entry is PUT' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitEntryIsPut

public final boolean getFlagCommitEntryIsPut()

Get the 'commit entry is PUT' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitEntryIsUpdate

public final void setFlagCommitEntryIsUpdate(boolean val)

Set the 'commit entry is UPDATE' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitEntryIsUpdate

public final boolean getFlagCommitEntryIsUpdate()

Get the 'commit entry is UPDATE' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitEntryIsRemove

public final void setFlagCommitEntryIsRemove(boolean val)

Set the 'commit entry is REMOVE' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitEntryIsRemove

public final boolean getFlagCommitEntryIsRemove()

Get the 'commit entry is REMOVE' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitEntryIsSend

public final void setFlagCommitEntryIsSend(boolean val)

Set the 'commit entry is SEND' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitEntryIsSend

public final boolean getFlagCommitEntryIsSend()

Get the 'commit entry is SEND' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

setFlagCommitEntryInInit

public final void setFlagCommitEntryInInit(boolean val)

Set the 'commit entry in INIT' flag

Threading:

This method is not safe for concurrent access by multiple threads

getFlagCommitEntryInInit

public final boolean getFlagCommitEntryInInit()

Get the 'commit entry in INIT' flag (V1 Subheader Field).

Threading:

This method is not safe for concurrent access by multiple threads

copyObjectMetadataFrom

public final void copyObjectMetadataFrom(PktBuffer metadata)

Copy the object metadata (V1 Subheader Field) from a packet buffer.

Threading:

This method is safe for concurrent access by multiple threads

getObjectMetadata

public final PktBuffer getObjectMetadata()

Get the object metadata (V1 Subheader Field).

The metadata returned by this method can be null.

Threading:

This method is safe for concurrent access by multiple threads

copyObjectMetadataTo

public final void copyObjectMetadataTo(PktBuffer buffer,
                                       int offset)

Copy the object metadata (V1 Subheader Field) to a packet buffer.

Threading:

This method is safe for concurrent access by multiple threads

copyPersisterMetadataFrom

public final void copyPersisterMetadataFrom(PktBuffer metadata)

Copy the persister metadata (V1 Subheader Field) from a packet buffer.

Threading:

This method is safe for concurrent access by multiple threads

getPersisterMetadata

public final PktBuffer getPersisterMetadata()

Get the persister metadata (V1 Subheader Field).

The metadata returned by this method can be null.

Threading:

This method is safe for concurrent access by multiple threads

copyPersisterMetadataTo

public final void copyPersisterMetadataTo(PktBuffer buffer,
                                          int offset)

Copy the persister metadata (V1 Subheader Field) to a packet buffer.

Threading:

This method is safe for concurrent access by multiple threads

initializeBuffer

public final void initializeBuffer()

Implementation of PktBuffer.Initializer.initializeBuffer()

Specified by:

initializeBuffer in interface PktBuffer.Initializer

Overrides:

initializeBuffer in class PktBody

toString

public final String toString()

Returns a string representation of the object

Overrides:

toString in class Object

Threading:

This method is safe for concurrent access by multiple threads