PktSubheaderODS (Rumi 4.0.595 API)

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

All Implemented Interfaces:

IOElasticBuffer.Initializer, IOElasticBuffer.Sizer
```
public final class PktSubheaderODS
extends PktSubheaderVariable
```
The ODS packet subheader.
This class is the subheader used by ODS store binding to hold serialized control information for store objects.

Threading:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`ENTRY_TYPE_MESSAGE` Specifies that the entry is for a message
`static short`	`ENTRY_TYPE_PUT` Specifies that the entry is for a put
`static short`	`ENTRY_TYPE_REMOVE` Specifies that the entry is for a remove
`static short`	`ENTRY_TYPE_SEND` Specifies that the entry is for a send
`static short`	`ENTRY_TYPE_UPDATE` Specifies that the entry is for an update
`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
`static byte`	`V1`
`static byte`	`V2`
`static byte`	`VERSION`

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`calcSerializedLength(ByteBuffer buffer, int offset)` Calculate serialized length of a serialized ODS subheader
`static int`	`calcSerializedLength(IOBuffer buffer, int offset)` Calculate serialized length of a serialized ODS subheader
`static int`	`calcSerializedLength(long addr, int offset)` Calculate serialized length of a serialized ODS subheader
`void`	`copyObjectMetadataFrom(IOElasticBuffer metadata)` Copy the object metadata (V1 Subheader Field) from an elastic IO buffer.
`void`	`copyObjectMetadataTo(IOElasticBuffer buffer, int offset)` Copy the object metadata (V1 Subheader Field) to a elastic IO buffer.
`void`	`copyPersisterMetadataFrom(IOElasticBuffer metadata)` Copy the persister metadata (V2 Subheader Field) from an elastic IO buffer.
`void`	`copyPersisterMetadataTo(IOElasticBuffer buffer, int offset)` Copy the persister metadata (V2 Subheader Field) to a elastic IO buffer.
`static PktBody`	`create()` Create a default ODS subheader with the latest version
`static PktBody`	`create(Properties props)` Create a latest version ODS subheader qualified by a property set
`static PktBody`	`create(short version)` Creates a ODS subheader of a specific version
`int`	`doGetInitialBufferLength()` Invoked to fetch the initial buffer length of the body for packet bodies The default implementation of this method invokes `PktBody.doGetSerializedLength()`.
`int`	`doGetSerializedLength()` Invoked to fetch the serialized length of the body
`long`	`getCheckpointVersion()` Get the checkpoint version (V1 Subheader Field).
`static long`	`getCheckpointVersion(long addr, int offset)` Get the checkpoint version (V1 Subheader Field).
`short`	`getCommitEntryType()` Get the commit entry type (V1 Subheader Field).
`static short`	`getCommitEntryType(long addr, int offset)` Get the commit entry type (V1 Subheader Field).
`short`	`getContentEncodingType()` Get the contentEncodingType type(V1 Subheader Field).
`static short`	`getContentEncodingType(long addr, int offset)` Get the content encoding type (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 int`	`getFlags(long addr, int offset)` Get the flags (V1 Subheader Field).
`static short`	`getLatestSubheaderVersion()` Get the latest subheader version.
`short`	`getObjectFactoryId()` Get the object factory id (V1 Subheader Field).
`static short`	`getObjectFactoryId(long addr, int offset)` Get the object factory id (V1 Subheader Field).
`com.eaio.uuid.UUID`	`getObjectId()` Get the object id (V1 Subheader Field).
`int`	`getObjectMetadataLength()` Get the object metadata length (V1 Subheader Field).
`int`	`getObjectMetadataOffset()` Get the object metadata offset into the backing buffer (V1 Subheader Field).
`short`	`getObjectType()` Get the object type (V1 Subheader Field).
`static short`	`getObjectType(long addr, int offset)` Get the object type (V1 Subheader Field).
`int`	`getPersisterMetadataLength()` Get the persister metadata length (V2 Subheader Field).
`int`	`getPersisterMetadataOffset()` Get the persister metadata offset into the backing buffer (V1 Subheader Field).
`int`	`getSerializedLength(ByteBuffer buffer, int offset)` Get the serialized length from the serialized form
`int`	`getSerializedLength(IOBuffer buffer, int offset)` Get the serialized length from the serialized form
`int`	`getSerializedLength(long addr, int offset)` Get the serialized length from the serialized form
`long`	`getStableTransactionId()` Get the stable transactionId (V1 Subheader Field).
`static long`	`getStableTransactionId(long addr, int offset)` Get the stable transaction id (V1 Subheader Field).
`short`	`getSubheaderVersion()` Get the header format version (V1 Subheader Field).
`long`	`getTimestamp()` Get the persist timestamp (V1 Subheader Field).
`long`	`getTransactionId()` Get the transactionId (V1 Subheader Field).
`static long`	`getTransactionId(long addr, int offset)` Get the transactionId (V1 Subheader Field).
`boolean`	`hasPersisterMetadata()` Get whether the subheader has persister metadata (V2 Subheader Field).
`void`	`initializeBuffer()` Implementation of `IOElasticBuffer.Initializer.initializeBuffer()` The default implementation of this method is no-op.
`static void`	`prepare(PktPacket packet, com.eaio.uuid.UUID objectId, short ofid, short otype, short contentEncodingType, long transactionId, long stableTransactionId, long checkpointVersion, long timestamp, byte flags)` Prepare a packet with an ODS subheader with latest version.
`void`	`setCheckpointVersion(long checkpointVersion)` Set the checkpoint version (V1 Subheader Field).
`static void`	`setCheckpointVersion(long addr, int offset, long val)` Set the checkpoint version (V1 Subheader Field).
`void`	`setCommitEntryType(short entryType)` Set the commit entry type (V1 Subheader Field).
`void`	`setContentEncodingType(short contentEncodingType)` Set the contentEncodingType type (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(byte flags)` Set the flags (V1 Subheader Field).
`static void`	`setFlags(long addr, int offset, byte val)` Set the flags (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`	`setObjectMetadataLengthUnsafe(short val)` Set the object metadata length (V1 Subheader Field)
`void`	`setObjectType(short otype)` Set the object type (V1 Subheader Field).
`void`	`setStableTransactionId(long stableTransactionId)` Set the stable transaction id (V1 Subheader Field).
`static void`	`setStableTransactionId(long addr, int offset, long val)` Set the stable transaction id (V1 Subheader Field).
`void`	`setTimestamp(long timestamp)` Set the persist timestamp (V1 Subheader Field).
`void`	`setTransactionId(long transactionId)` Set the transaction id (V1 Subheader Field).
`static void`	`setTransactionId(long addr, int offset, long val)` Set the transactionId (V1 Subheader Field).
`String`	`toString()` Returns a string representation of the object

Methods inherited from class com.neeve.pkt.PktSubheader
getType, getType, getType

Methods inherited from class com.neeve.pkt.PktBody
deserialize, deserialize, deserialize, deserialize, deserialize, deserialize, deserialize, desync, dump, getBuffer, getInitialBufferLength, getSerializedLength, getTo, getTo, getTo, getTo, getTo, getTo, getTo, getType, putFrom, putFrom, putFrom, putFrom, putFrom, putFrom, putFrom, putFrom, reset, reset, serialize, serialize, serialize, serialize, serialize, serialize, sync, syncf

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
  - V1
```
public static final byte V1
```
    See Also:
    
    Constant Field Values
  - V2
```
public static final byte V2
```
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final byte VERSION
```
    See Also:
    
    Constant Field Values
  - 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
  - ENTRY_TYPE_PUT
```
public static final short ENTRY_TYPE_PUT
```
    Specifies that the entry is for a put
    
    See Also:
    
    Constant Field Values
  - ENTRY_TYPE_UPDATE
```
public static final short ENTRY_TYPE_UPDATE
```
    Specifies that the entry is for an update
    
    See Also:
    
    Constant Field Values
  - ENTRY_TYPE_REMOVE
```
public static final short ENTRY_TYPE_REMOVE
```
    Specifies that the entry is for a remove
    
    See Also:
    
    Constant Field Values
  - ENTRY_TYPE_SEND
```
public static final short ENTRY_TYPE_SEND
```
    Specifies that the entry is for a send
    
    See Also:
    
    Constant Field Values
  - ENTRY_TYPE_MESSAGE
```
public static final short ENTRY_TYPE_MESSAGE
```
    Specifies that the entry is for a message
    
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
public static PktBody create(Properties props)
```
    Create a latest version ODS subheader qualified by a property set
    
    Parameters:
    
    props - The property set to use to qualify creation of the body.
  - create
```
public static PktBody create()
```
    Create a default ODS subheader with the latest version
  - create
```
public static PktBody create(short version)
```
    Creates a ODS subheader of a specific version
  - prepare
```
public static void prepare(PktPacket packet,
                           com.eaio.uuid.UUID objectId,
                           short ofid,
                           short otype,
                           short contentEncodingType,
                           long transactionId,
                           long stableTransactionId,
                           long checkpointVersion,
                           long timestamp,
                           byte flags)
```
    Prepare a packet with an ODS subheader with latest version.
    
    Parameters:
    
    packet - The packet to prepare.
    
    objectId - The object id to set.
    
    ofid - The object's factory id.
    
    otype - The object's type.
    
    contentEncodingType - The encoding type to set.
    
    transactionId - The current transaction id.
    
    stableTransactionId - The stable transaction id.
    
    checkpointVersion - The checkpoint version.
    
    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
  - calcSerializedLength
```
public static final int calcSerializedLength(ByteBuffer buffer,
                                             int offset)
```
    Calculate serialized length of a serialized ODS subheader
  - calcSerializedLength
```
public static final int calcSerializedLength(IOBuffer buffer,
                                             int offset)
```
    Calculate serialized length of a serialized ODS subheader
  - calcSerializedLength
```
public static final int calcSerializedLength(long addr,
                                             int offset)
```
    Calculate serialized length of a serialized ODS subheader
  - doGetSerializedLength
```
public final int doGetSerializedLength()
```
    Description copied from class: PktBody
    
    Invoked to fetch the serialized length of the body
  - getSerializedLength
```
public final int getSerializedLength(ByteBuffer buffer,
                                     int offset)
```
    Description copied from class: PktSubheader
    
    Get the serialized length from the serialized form
    
    Specified by:
    
    getSerializedLength in class PktSubheader
  - getSerializedLength
```
public final int getSerializedLength(IOBuffer buffer,
                                     int offset)
```
    Description copied from class: PktSubheader
    
    Get the serialized length from the serialized form
    
    Specified by:
    
    getSerializedLength in class PktSubheader
  - getSerializedLength
```
public final int getSerializedLength(long addr,
                                     int offset)
```
    Description copied from class: PktSubheader
    
    Get the serialized length from the serialized form
    
    Specified by:
    
    getSerializedLength in class PktSubheader
  - doGetInitialBufferLength
```
public final int doGetInitialBufferLength()
```
    Description copied from class: PktBody
    
    Invoked to fetch the initial buffer length of the body for packet bodies
    The default implementation of this method invokes PktBody.doGetSerializedLength(). The concrete body implementation should override this method in case it has a better estimate for the initial length of the backing buffer or if the doGetSerializedLength implementation uses the backing buffer to calculate serialized length (which is illegal per the IOElasticBuffer contract).
  - 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
  - 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.
  - getObjectFactoryId
```
public static final short getObjectFactoryId(long addr,
                                             int offset)
```
    Get the object factory id (V1 Subheader Field).
    
    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.
  - getObjectType
```
public static final short getObjectType(long addr,
                                        int offset)
```
    Get the object type (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.
  - getContentEncodingType
```
public static final short getContentEncodingType(long addr,
                                                 int offset)
```
    Get the content encoding 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.
  - setTimestamp
```
public final void setTimestamp(long timestamp)
```
    Set the persist timestamp (V1 Subheader Field).
    
    Parameters:
    
    timestamp - The timestamp to set.
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - getTimestamp
```
public final long getTimestamp()
```
    Get the persist timestamp (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - getCommitEntryType
```
public static final short getCommitEntryType(long addr,
                                             int offset)
```
    Get the commit entry type (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - setCommitEntryType
```
public final void setCommitEntryType(short entryType)
```
    Set the commit entry type (V1 Subheader Field).
    
    Parameters:
    
    entryType - The commit entry type to set.
    
    Threading:
    
    This method is not safe for cConcurrent access by multiple threads.
  - getCommitEntryType
```
public final short getCommitEntryType()
```
    Get the commit entry type (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - setTransactionId
```
public static final void setTransactionId(long addr,
                                          int offset,
                                          long val)
```
    Set the transactionId (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - getTransactionId
```
public static final long getTransactionId(long addr,
                                          int offset)
```
    Get the transactionId (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 static final void setStableTransactionId(long addr,
                                                int offset,
                                                long val)
```
    Set the stable transaction id (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - getStableTransactionId
```
public static final long getStableTransactionId(long addr,
                                                int offset)
```
    Get the stable transaction id (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 static final void setCheckpointVersion(long addr,
                                              int offset,
                                              long val)
```
    Set the checkpoint version (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - getCheckpointVersion
```
public static final long getCheckpointVersion(long addr,
                                              int offset)
```
    Get the checkpoint version (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 static final void setFlags(long addr,
                                  int offset,
                                  byte val)
```
    Set the flags (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - getFlags
```
public static final int getFlags(long addr,
                                 int offset)
```
    Get the flags (V1 Subheader Field).
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads.
  - setFlags
```
public final void setFlags(byte 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
  - setObjectMetadataLengthUnsafe
```
public final void setObjectMetadataLengthUnsafe(short val)
```
    Set the object metadata length (V1 Subheader Field)
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
    NOTE: THIS METHOD IS MARKED AS UNSAFE SINCE IT IS UNSAFE TO SET THE OBJECT METADATA LENGTH INDEPENDENTLY OF COPYING THE SERIALIZED METADATA.
    
    NOTE: THIS METHOD IS INTENDED INTERNAL USE BY THE PLATFORM.
  - getObjectMetadataLength
```
public final int getObjectMetadataLength()
```
    Get the object metadata length (V1 Subheader Field).
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getObjectMetadataOffset
```
public final int getObjectMetadataOffset()
```
    Get the object metadata offset into the backing buffer (V1 Subheader Field).
    This method returns the offset into the subheader's backing buffer (obtained via PktBody.getBuffer() where the object metadata field is serialized.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - copyObjectMetadataFrom
```
public final void copyObjectMetadataFrom(IOElasticBuffer metadata)
```
    Copy the object metadata (V1 Subheader Field) from an elastic IO buffer.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - copyObjectMetadataTo
```
public final void copyObjectMetadataTo(IOElasticBuffer buffer,
                                       int offset)
```
    Copy the object metadata (V1 Subheader Field) to a elastic IO buffer.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - hasPersisterMetadata
```
public final boolean hasPersisterMetadata()
```
    Get whether the subheader has persister metadata (V2 Subheader Field).
    Note that this method does not return whether the subheader has persister metadata or not. It only returns whether the header version supports persister metadata
    
    Returns:
    
    whether the subheader contains the persister metadata field
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getPersisterMetadataOffset
```
public final int getPersisterMetadataOffset()
```
    Get the persister metadata offset into the backing buffer (V1 Subheader Field).
    This method returns the offset into the subheader's backing buffer (obtained via PktBody.getBuffer() where the persister metadata field is serialized.
    
    Throws:
    
    IllegalStateException - if the subheader version is not already 2. The caller should only invoke this method if hasPersisterMetadata() returns true
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - getPersisterMetadataLength
```
public final int getPersisterMetadataLength()
```
    Get the persister metadata length (V2 Subheader Field).
    
    Returns:
    
    the serialized length of the persister metadata in the backing buffer
    
    Throws:
    
    IllegalStateException - if the subheader version is not already 2. The caller should only invoke this method if hasPersisterMetadata() returns true
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - copyPersisterMetadataFrom
```
public final void copyPersisterMetadataFrom(IOElasticBuffer metadata)
```
    Copy the persister metadata (V2 Subheader Field) from an elastic IO buffer.
    
    Parameters:
    
    buffer - The buffer to copy the persister metadata from
    
    Throws:
    
    IllegalStateException - if the subheader version is not already 2. The caller should only invoke this method if hasPersisterMetadata() returns true
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - copyPersisterMetadataTo
```
public final void copyPersisterMetadataTo(IOElasticBuffer buffer,
                                          int offset)
```
    Copy the persister metadata (V2 Subheader Field) to a elastic IO buffer.
    
    Parameters:
    
    buffer - The buffer to copy the persister metadata to
    
    offset - The offset into the elastic IO buffer to copy the metadata to.
    
    Throws:
    
    IllegalStateException - if the subheader version is not already 2. The caller should only invoke this method if hasPersisterMetadata() returns true
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - initializeBuffer
```
public final void initializeBuffer()
```
    Description copied from class: PktBody
    
    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
    
    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

Class PktSubheaderODS

Field Summary

Fields inherited from class com.neeve.pkt.PktSubheader

Fields inherited from class com.neeve.util.UtlListElement

Method Summary

Methods inherited from class com.neeve.pkt.PktSubheader

Methods inherited from class com.neeve.pkt.PktBody

Methods inherited from class com.neeve.util.UtlListElement

Methods inherited from class java.lang.Object

Field Detail

V1

V2

VERSION

FLAG_COMMIT_START

FLAG_COMMIT_END

FLAG_COMMIT_ACK_REQUIRED

FLAG_COMMIT_ENTRY_IS_PUT

FLAG_COMMIT_ENTRY_IS_UPDATE

FLAG_COMMIT_ENTRY_IS_REMOVE

FLAG_COMMIT_ENTRY_IS_SEND

FLAG_COMMIT_ENTRY_IN_INIT

ENTRY_TYPE_PUT

ENTRY_TYPE_UPDATE

ENTRY_TYPE_REMOVE

ENTRY_TYPE_SEND

ENTRY_TYPE_MESSAGE

Method Detail

create

create

create

prepare

getLatestSubheaderVersion

calcSerializedLength

calcSerializedLength

calcSerializedLength

doGetSerializedLength

getSerializedLength

getSerializedLength

getSerializedLength

doGetInitialBufferLength

getSubheaderVersion

setObjectId

getObjectId

getObjectFactoryId

setObjectFactoryId

getObjectFactoryId

getObjectType

setObjectType

getObjectType

getContentEncodingType

setContentEncodingType

getContentEncodingType

setTimestamp

getTimestamp

getCommitEntryType

setCommitEntryType

getCommitEntryType

setTransactionId

getTransactionId

setTransactionId

getTransactionId

setStableTransactionId

getStableTransactionId

setStableTransactionId

getStableTransactionId

setCheckpointVersion

getCheckpointVersion

setCheckpointVersion

getCheckpointVersion

setFlags

getFlags

setFlags

getFlags

setFlagCommitStart

getFlagCommitStart

setFlagCommitEnd

getFlagCommitEnd

setFlagCommitAckRequired

getFlagCommitAckRequired

setFlagCommitEntryIsPut