MessageMetadata (Rumi 4.0.595 API)

java.lang.Object
- com.neeve.util.UtlListElement
- - com.neeve.sma.MessageMetadata

All Implemented Interfaces:

UtlPool.Item<MessageMetadata>
```
public final class MessageMetadata
extends UtlListElement
implements UtlPool.Item<MessageMetadata>
```
Helper class to transport message metadata.
This class serves as helper class for provider implementations that do not possess native capabilities to transport message metadata elements (sender, flow, sno, ...) natively. The class provides facilities to serialize and deserialize metadata elements to/from a flat wire format for use by the provider implementations to transport the metadata elements across the wire.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FIXED_WIRE_LENGTH`
`static int`	`FIXED_WIRE_LENGTH_V1`
`static int`	`FIXED_WIRE_LENGTH_V2`
`static int`	`FIXED_WIRE_LENGTH_V3`
`static byte`	`V1`
`static byte`	`V2`
`static byte`	`V3`
`static byte`	`VERSION`

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
`MessageMetadata`	`acquire()` Acquires the `MessageMetadata` preventing it from being returned to the underlying pool.
`int`	`deserialize(ByteBuffer serializedMetadata)` Deserialize contents from a byte buffer
`void`	`dispose()` Dispose off this `MessageMetadata`
`IOElasticBuffer`	`getBuffer()` Get the backing buffer The metadata object manipulates its field in place in its backing buffer returned by this method.
`static short`	`getLatestVersion()` Get the latest metadata version.
`short`	`getMessageChannelId()` Get the message channel id (V1 metadata Field).
`static short`	`getMessageChannelId(ByteBuffer buffer)` Get the message channel id (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageChannelId(ByteBuffer buffer, int offset)` Get the message channel id (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageChannelId(IOBuffer buffer)` Get the message channel id (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageChannelId(IOBuffer buffer, int offset)` Get the message channel id (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageChannelId(long addr, int offset)` Get the message channel id (V1 metadata Field) from a native memory region.
`static short`	`getMessageChannelId(short version, long addr, int offset)` Get the message channel id (V1 metadata Field) from a native memory region.
`String`	`getMessageChannelName()` Get the message channel name (V1 metadata Field).
`static String`	`getMessageChannelName(ByteBuffer buffer)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`static String`	`getMessageChannelName(ByteBuffer buffer, int offset)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`static String`	`getMessageChannelName(long addr, int offset)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`XString`	`getMessageChannelNameAsRaw()` Get the message channel name (V1 metadata Field).
`static int`	`getMessageChannelNameLength(long addr, int offset)` Get the message channel name length (V1 metadata Field) in a serialized buffer.
`static int`	`getMessageChannelNameLength(short version, long addr, int offset)` Get the message channel name length (V1 metadata Field) in a serialized buffer.
`static int`	`getMessageChannelNamePos(long addr, int offset)` Get the message channel name offset (V1 metadata Field) in a serialized buffer.
`static int`	`getMessageChannelNamePos(short version, long addr, int offset)` Get the message channel name offset (V1 metadata Field) in a serialized buffer.
`static void`	`getMessageChannelNameToRaw(ByteBuffer buffer, int offset, XString target)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`static void`	`getMessageChannelNameToRaw(ByteBuffer buffer, XString target)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`static void`	`getMessageChannelNameToRaw(IOBuffer buffer, int offset, XString target)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`static void`	`getMessageChannelNameToRaw(IOBuffer buffer, XString target)` Get the message channel name (V1 metadata Field) from a serialized buffer.
`static void`	`getMessageChannelNameToRaw(long addr, int offset, XString target)` Get the message channel name (V1 metadata Field) from a native memory region.
`byte`	`getMessageEncodingType()` Get the message encoding type (V1 metadata Field).
`static byte`	`getMessageEncodingType(ByteBuffer buffer)` Get the message encoding type (V1 metadata Field) from a serialized buffer.
`static byte`	`getMessageEncodingType(ByteBuffer buffer, int offset)` Get the message encoding type (V1 metadata Field) from a serialized buffer.
`static byte`	`getMessageEncodingType(long addr, int offset)` Get the message encoding type (V1 metadata Field) from a serialized buffer.
`static byte`	`getMessageEncodingType(short version, long addr, int offset)` Get the message encoding type (V1 metadata Field) from a serialized buffer.
`int`	`getMessageFlow()` Get the message flow (V1 metadata Field).
`static int`	`getMessageFlow(ByteBuffer buffer)` Get the message flow (V1 metadata Field) from a serialized buffer.
`static int`	`getMessageFlow(ByteBuffer buffer, int offset)` Get the message flow (V1 metadata Field) from a serialized buffer.
`static int`	`getMessageFlow(long addr, int offset)` Get the message flow (V1 metadata Field) from a serialized buffer.
`static int`	`getMessageFlow(short version, long addr, int offset)` Get the message flow (V1 metadata Field) from a serialized buffer.
`int`	`getMessageSender()` Get the message sender (V1 metadata Field).
`static int`	`getMessageSender(ByteBuffer buffer)` Get the message sender (V1 metadata Field) from a serialized buffer
`static int`	`getMessageSender(ByteBuffer buffer, int offset)` Get the message sender (V1 metadata Field) from a serialized buffer
`static int`	`getMessageSender(long addr, int offset)` Get the message sender (V1 metadata Field) from a serialized buffer
`static int`	`getMessageSender(short version, long addr, int offset)` Get the message sender (V1 metadata Field) from a serialized buffer
`long`	`getMessageSno()` Get the message sequence number (V1 metadata Field).
`static long`	`getMessageSno(ByteBuffer buffer)` Get the message sequence number (V1 metadata Field) from a serialized buffer.
`static long`	`getMessageSno(ByteBuffer buffer, int offset)` Get the message sequence number (V1 metadata Field) from a serialized buffer.
`static long`	`getMessageSno(long addr, int offset)` Get the message sequence number (V1 metadata Field) from a serialized buffer.
`static long`	`getMessageSno(short version, long addr, int offset)` Get the message sequence number (V1 metadata Field) from a serialized buffer.
`short`	`getMessageViewFactory()` Get the message view factory (V1 metadata Field).
`static short`	`getMessageViewFactory(ByteBuffer buffer)` Get the message view factory (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageViewFactory(ByteBuffer buffer, int offset)` Get the message view factory (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageViewFactory(long addr, int offset)` Get the message view factory (V1 metadata Field) from a serialized buffer.
`static short`	`getMessageViewFactory(short version, long addr, int offset)` Get the message view factory (V1 metadata Field) from a serialized buffer.
`short`	`getMessageViewType()` Get the message view (V2 metadata Field).
`static short`	`getMessageViewType(ByteBuffer buffer)` Get the message view (V2 metadata Field) from a serialized buffer.
`static short`	`getMessageViewType(ByteBuffer buffer, int offset)` Get the message view (V2 metadata Field) from a serialized buffer.
`static short`	`getMessageViewType(long addr, int offset)` Get the message view (V2 metadata Field) from a serialized buffer.
`static short`	`getMessageViewType(short version, long addr, int offset)` Get the message view (V2 metadata Field) from a serialized buffer.
`UtlPool<MessageMetadata>`	`getPool()` Implementation of UtlPool.Item#getPool
`long`	`getRequestId()` Get the request id (V3 metadata Field).
`static long`	`getRequestId(ByteBuffer buffer)` Get the request id (V3 metadata Field) from a serialized buffer.
`static long`	`getRequestId(ByteBuffer buffer, int offset)` Get the request id (V3 metadata Field) from a serialized buffer.
`static long`	`getRequestId(IOBuffer buffer)` Get the request id (V3 metadata Field) from a serialized buffer.
`static long`	`getRequestId(IOBuffer buffer, int offset)` Get the request id (V3 metadata Field) from a serialized buffer.
`static long`	`getRequestId(long addr, int offset)` Get the request id (V3 metadata Field) from a serialized buffer.
`static long`	`getRequestId(short version, long addr, int offset)` Get the request id (V3 metadata Field) from a serialized buffer.
`String`	`getRequestorId()` Get the requestor id (V1 metadata Field).
`static String`	`getRequestorId(ByteBuffer buffer)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static String`	`getRequestorId(ByteBuffer buffer, int offset)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static String`	`getRequestorId(long addr, int offset)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`XString`	`getRequestorIdAsRaw()` Get the requestor id (V1 metadata Field).
`static void`	`getRequestorIdToRaw(ByteBuffer buffer, int offset, XString target)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static void`	`getRequestorIdToRaw(ByteBuffer buffer, XString target)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static void`	`getRequestorIdToRaw(IOBuffer buffer, int offset, XString target)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static void`	`getRequestorIdToRaw(IOBuffer buffer, XString target)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static XString`	`getRequestorIdToRaw(long addr, int offset, XString target)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`static XString`	`getRequestorIdToRaw(short version, long addr, int offset, XString target)` Get the requestor id (V1 metadata Field) from a serialized buffer.
`int`	`getSerializedLength()` Get the serialized length of the message metadata elements.
`static int`	`getSerializedLength(short version, ByteBuffer buffer)` Get the serialized length of the message metadata wire format for a given wire format version.
`static int`	`getSerializedLength(short version, ByteBuffer buffer, int offset)` Get the serialized length of the message metadata wire format for a given wire format version.
`static int`	`getSerializedLength(short version, long addr, int offset)` Get the serialized length of the message metadata wire format for a given wire format version.
`short`	`getVersion()` Get the metadata version (V1 metadata Field).
`static short`	`getVersion(long addr, int offset)` Get the metadata version from a serialized metadata wire block.
`MessageMetadata`	`init()` Implementation of UtlPool.Item#init
`void`	`serializeV1(byte encodingType, short vfid, int sender, int flow, long sno, short channelId, XString channelName)` Serialize version 1 metadata content
`static int`	`serializeV1(byte encodingType, short vfid, int sender, int flow, long sno, short channelId, XString channelName, IOElasticBuffer buffer)` Serialize version 1 metadata content
`void`	`serializeV2(byte encodingType, short vfid, short vid, int sender, int flow, long sno, short channelId, XString channelName)` Serialize version 2 metadata content
`static int`	`serializeV2(byte encodingType, short vfid, short vid, int sender, int flow, long sno, short channelId, XString channelName, ByteBuffer buffer, int offset)` Serialize version 2 metadata content
`static int`	`serializeV2(byte encodingType, short vfid, short vid, int sender, int flow, long sno, short channelId, XString channelName, IOElasticBuffer buffer)` Serialize version 2 metadata content
`void`	`serializeV3(byte encodingType, short vfid, short vid, int sender, int flow, long sno, short channelId, XString channelName, long requestId, XString requestorId)` Serialize version 2 metadata content
`static int`	`serializeV3(byte encodingType, short vfid, short vid, int sender, int flow, long sno, short channelId, XString channelName, long requestId, XString requestorId, ByteBuffer buffer, int offset)` Serialize version 3 metadata content
`static int`	`serializeV3(byte encodingType, short vfid, short vid, int sender, int flow, long sno, short channelId, XString channelName, long requestId, XString requestorId, IOElasticBuffer buffer)` Serialize version 2 metadata content
`MessageMetadata`	`setPool(UtlPool<MessageMetadata> pool)` Implementation of UtlPool.Item#setPool
`String`	`toString()` Return a string representation of the object.
`static String`	`toString(long addr, int offset)` Return a string representation of the object.
`static void`	`tryWrap(long serializedMetadata, int serializedMetadataLength)` Try to wrap a metadata object around a memory region
`int`	`wrap(IOBuffer serializedMetadata)` Wrap a metadata object around an IO buffer.
`int`	`wrap(IOBuffer serializedMetadata, int serializedMetadataLength)` Wrap a metadata object around an IO buffer.

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
- FIXED_WIRE_LENGTH_V1
```
public static final int FIXED_WIRE_LENGTH_V1
```
  See Also:
  
  Constant Field Values
- FIXED_WIRE_LENGTH_V2
```
public static final int FIXED_WIRE_LENGTH_V2
```
  See Also:
  
  Constant Field Values
- FIXED_WIRE_LENGTH_V3
```
public static final int FIXED_WIRE_LENGTH_V3
```
  See Also:
  
  Constant Field Values
- FIXED_WIRE_LENGTH
```
public static final int FIXED_WIRE_LENGTH
```
  See Also:
  
  Constant Field Values
- V1
```
public static final byte V1
```
  See Also:
  
  Constant Field Values
- V2
```
public static final byte V2
```
  See Also:
  
  Constant Field Values
- V3
```
public static final byte V3
```
  See Also:
  
  Constant Field Values
- VERSION
```
public static final byte VERSION
```
  See Also:
  
  Constant Field Values

Method Detail

getLatestVersion
```
public static final short getLatestVersion()
```
Get the latest metadata version.

getSerializedLength

public static final int getSerializedLength(short version,
                                            ByteBuffer buffer,
                                            int offset)

Get the serialized length of the message metadata wire format for a given wire format version.

getSerializedLength

public static final int getSerializedLength(short version,
                                            ByteBuffer buffer)

Get the serialized length of the message metadata wire format for a given wire format version.

getSerializedLength

public static final int getSerializedLength(short version,
                                            long addr,
                                            int offset)

Get the serialized length of the message metadata wire format for a given wire format version.

getVersion

public static final short getVersion(long addr,
                                     int offset)

Get the metadata version from a serialized metadata wire block.

getVersion
```
public final short getVersion()
```
Get the metadata version (V1 metadata Field).

getMessageEncodingType

public static final byte getMessageEncodingType(ByteBuffer buffer,
                                                int offset)

Get the message encoding type (V1 metadata Field) from a serialized buffer.

getMessageEncodingType
```
public static final byte getMessageEncodingType(ByteBuffer buffer)
```
Get the message encoding type (V1 metadata Field) from a serialized buffer.

getMessageEncodingType

public static final byte getMessageEncodingType(short version,
                                                long addr,
                                                int offset)

Get the message encoding type (V1 metadata Field) from a serialized buffer.

getMessageEncodingType

public static final byte getMessageEncodingType(long addr,
                                                int offset)

Get the message encoding type (V1 metadata Field) from a serialized buffer.

getMessageEncodingType
```
public final byte getMessageEncodingType()
```
Get the message encoding type (V1 metadata Field).

getMessageViewFactory

public static final short getMessageViewFactory(ByteBuffer buffer,
                                                int offset)

Get the message view factory (V1 metadata Field) from a serialized buffer.

getMessageViewFactory
```
public static final short getMessageViewFactory(ByteBuffer buffer)
```
Get the message view factory (V1 metadata Field) from a serialized buffer.

getMessageViewFactory

public static final short getMessageViewFactory(short version,
                                                long addr,
                                                int offset)

Get the message view factory (V1 metadata Field) from a serialized buffer.

getMessageViewFactory

public static final short getMessageViewFactory(long addr,
                                                int offset)

Get the message view factory (V1 metadata Field) from a serialized buffer.

getMessageViewFactory
```
public final short getMessageViewFactory()
```
Get the message view factory (V1 metadata Field).

getMessageViewType

public static final short getMessageViewType(ByteBuffer buffer,
                                             int offset)

Get the message view (V2 metadata Field) from a serialized buffer.

getMessageViewType
```
public static final short getMessageViewType(ByteBuffer buffer)
```
Get the message view (V2 metadata Field) from a serialized buffer.

getMessageViewType

public static final short getMessageViewType(short version,
                                             long addr,
                                             int offset)

Get the message view (V2 metadata Field) from a serialized buffer.

getMessageViewType

public static final short getMessageViewType(long addr,
                                             int offset)

Get the message view (V2 metadata Field) from a serialized buffer.

getMessageViewType
```
public final short getMessageViewType()
```
Get the message view (V2 metadata Field).

getMessageSender

public static final int getMessageSender(ByteBuffer buffer,
                                         int offset)

Get the message sender (V1 metadata Field) from a serialized buffer

getMessageSender
```
public static final int getMessageSender(ByteBuffer buffer)
```
Get the message sender (V1 metadata Field) from a serialized buffer

getMessageSender

public static final int getMessageSender(short version,
                                         long addr,
                                         int offset)

Get the message sender (V1 metadata Field) from a serialized buffer

getMessageSender

public static final int getMessageSender(long addr,
                                         int offset)

Get the message sender (V1 metadata Field) from a serialized buffer

getMessageSender
```
public final int getMessageSender()
```
Get the message sender (V1 metadata Field).

getMessageFlow

public static final int getMessageFlow(ByteBuffer buffer,
                                       int offset)

Get the message flow (V1 metadata Field) from a serialized buffer.

getMessageFlow
```
public static final int getMessageFlow(ByteBuffer buffer)
```
Get the message flow (V1 metadata Field) from a serialized buffer.

getMessageFlow

public static final int getMessageFlow(short version,
                                       long addr,
                                       int offset)

Get the message flow (V1 metadata Field) from a serialized buffer.

getMessageFlow

public static final int getMessageFlow(long addr,
                                       int offset)

Get the message flow (V1 metadata Field) from a serialized buffer.

getMessageFlow
```
public final int getMessageFlow()
```
Get the message flow (V1 metadata Field).

getMessageSno

public static final long getMessageSno(ByteBuffer buffer,
                                       int offset)

Get the message sequence number (V1 metadata Field) from a serialized buffer.

getMessageSno
```
public static final long getMessageSno(ByteBuffer buffer)
```
Get the message sequence number (V1 metadata Field) from a serialized buffer.

getMessageSno

public static final long getMessageSno(short version,
                                       long addr,
                                       int offset)

Get the message sequence number (V1 metadata Field) from a serialized buffer.

getMessageSno

public static final long getMessageSno(long addr,
                                       int offset)

Get the message sequence number (V1 metadata Field) from a serialized buffer.

getMessageSno
```
public final long getMessageSno()
```
Get the message sequence number (V1 metadata Field).

getMessageChannelId

public static final short getMessageChannelId(IOBuffer buffer,
                                              int offset)

Get the message channel id (V1 metadata Field) from a serialized buffer.

getMessageChannelId
```
public static final short getMessageChannelId(IOBuffer buffer)
```
Get the message channel id (V1 metadata Field) from a serialized buffer.

getMessageChannelId

public static final short getMessageChannelId(ByteBuffer buffer,
                                              int offset)

Get the message channel id (V1 metadata Field) from a serialized buffer.

getMessageChannelId
```
public static final short getMessageChannelId(ByteBuffer buffer)
```
Get the message channel id (V1 metadata Field) from a serialized buffer.

getMessageChannelId

public static final short getMessageChannelId(short version,
                                              long addr,
                                              int offset)

Get the message channel id (V1 metadata Field) from a native memory region.

getMessageChannelId

public static final short getMessageChannelId(long addr,
                                              int offset)

Get the message channel id (V1 metadata Field) from a native memory region.

getMessageChannelId
```
public final short getMessageChannelId()
```
Get the message channel id (V1 metadata Field).

getRequestId

public static final long getRequestId(IOBuffer buffer,
                                      int offset)

Get the request id (V3 metadata Field) from a serialized buffer.

getRequestId
```
public static final long getRequestId(IOBuffer buffer)
```
Get the request id (V3 metadata Field) from a serialized buffer.

getRequestId

public static final long getRequestId(ByteBuffer buffer,
                                      int offset)

Get the request id (V3 metadata Field) from a serialized buffer.

getRequestId
```
public static final long getRequestId(ByteBuffer buffer)
```
Get the request id (V3 metadata Field) from a serialized buffer.

getRequestId

public static final long getRequestId(short version,
                                      long addr,
                                      int offset)

Get the request id (V3 metadata Field) from a serialized buffer.

getRequestId

public static final long getRequestId(long addr,
                                      int offset)

Get the request id (V3 metadata Field) from a serialized buffer.

getRequestId
```
public final long getRequestId()
```
Get the request id (V3 metadata Field).

getMessageChannelName

public static final String getMessageChannelName(ByteBuffer buffer,
                                                 int offset)

Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelName
```
public static final String getMessageChannelName(ByteBuffer buffer)
```
Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelName

public static final String getMessageChannelName(long addr,
                                                 int offset)

Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelNameToRaw

public static final void getMessageChannelNameToRaw(IOBuffer buffer,
                                                    int offset,
                                                    XString target)

Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelNameToRaw

public static final void getMessageChannelNameToRaw(IOBuffer buffer,
                                                    XString target)

Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelNameToRaw

public static final void getMessageChannelNameToRaw(ByteBuffer buffer,
                                                    int offset,
                                                    XString target)

Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelNameToRaw

public static final void getMessageChannelNameToRaw(ByteBuffer buffer,
                                                    XString target)

Get the message channel name (V1 metadata Field) from a serialized buffer.

getMessageChannelNameToRaw

public static final void getMessageChannelNameToRaw(long addr,
                                                    int offset,
                                                    XString target)

Get the message channel name (V1 metadata Field) from a native memory region.

getMessageChannelNamePos

public static final int getMessageChannelNamePos(short version,
                                                 long addr,
                                                 int offset)

Get the message channel name offset (V1 metadata Field) in a serialized buffer.

getMessageChannelNamePos

public static final int getMessageChannelNamePos(long addr,
                                                 int offset)

Get the message channel name offset (V1 metadata Field) in a serialized buffer.

getMessageChannelNameLength

public static final int getMessageChannelNameLength(short version,
                                                    long addr,
                                                    int offset)

Get the message channel name length (V1 metadata Field) in a serialized buffer.

getMessageChannelNameLength

public static final int getMessageChannelNameLength(long addr,
                                                    int offset)

Get the message channel name length (V1 metadata Field) in a serialized buffer.

getMessageChannelNameAsRaw
```
public final XString getMessageChannelNameAsRaw()
```
Get the message channel name (V1 metadata Field).

getMessageChannelName
```
public final String getMessageChannelName()
```
Get the message channel name (V1 metadata Field).