MessageView (Talon 3.14.19 API)

All Superinterfaces:

UtlReferenceTracker.HasReferenceTracker

All Known Subinterfaces:

CopyableMessageView<T>, IRogBooleanMap<T>, IRogByteMap<T>, IRogCharMap<T>, IRogCollectionNode<T>, IRogCollectionNodeElement, IRogContainerNode, IRogCopyableNode<T>, IRogDoubleMap<T>, IRogDoubleMapElement, IRogFloatMap<T>, IRogIntMap<T>, IRogIntMapElement, IRogList<T>, IRogListElement, IRogLongMap<T>, IRogLongMapElement, IRogMessage, IRogNode, IRogPojoShadowNode<T>, IRogQuarkStringMapElement, IRogQueue<T>, IRogQueueElement, IRogRawMessage, IRogSet<T>, IRogShortMap<T>, IRogStringMap<T>, IRogStringMapElement, ISrvMonAppBusBindingCreatedMessage, ISrvMonAppBusBindingCreateFailedMessage, ISrvMonAppBusBindingCreateMessage, ISrvMonAppBusBindingDestroyedMessage, ISrvMonAppBusBindingDestroyMessage, ISrvMonAppBusBindingDownMessage, ISrvMonAppBusBindingOpenedMessage, ISrvMonAppBusBindingOpenFailedMessage, ISrvMonAppBusBindingOpeningMessage, ISrvMonAppBusBindingStateChangeMessage, ISrvMonAppBusBindingStateChangeMessage, ISrvMonAppBusBindingUpMessage, ISrvMonAppBusChannelClosedMessage, ISrvMonAppBusChannelOpenedMessage, ISrvMonAppChannelDownMessage, ISrvMonAppChannelUpMessage, ISrvMonAppClientConnectMessage, ISrvMonAppClientConnectMessage, ISrvMonAppClientDisconnectMessage, ISrvMonAppClientDisconnectMessage, ISrvMonAppDuplicateAcknowledgementAlertMessage, ISrvMonAppEngineActiveMessage, ISrvMonAppEngineCreatedMessage, ISrvMonAppEngineStartedMessage, ISrvMonAppEngineStoppedMessage, ISrvMonAppEngineStoppingMessage, ISrvMonAppExceptionMessage, ISrvMonAppFlowCreateMessage, ISrvMonAppFlowCreateMessage, ISrvMonAppInboundLogExceptionMessage, ISrvMonAppLoadedMessage, ISrvMonAppLoadedMessage, ISrvMonAppMessagingFailedMessage, ISrvMonAppMessagingPrestartMessage, ISrvMonAppMessagingStartedMessage, ISrvMonAppMessagingStartFailedMessage, ISrvMonAppOutboundLogExceptionMessage, ISrvMonAppOutOfOrderSendCommitCompletionAlertMessage, ISrvMonAppSendExceptionMessage, ISrvMonAppStateChangeMessage, ISrvMonAppStateChangeMessage, ISrvMonAppStatsAlertMessage, ISrvMonAppStoreBindingFailedMessage, ISrvMonAppStoreBindingRoleChangedMessage, ISrvMonAppStoreMemberDownMessage, ISrvMonAppStoreMemberInitCompleteMessage, ISrvMonAppStoreMemberUpMessage, ISrvMonAppStoreTransactionLogRepairedMessage, ISrvMonAppStuckAlertMessage, ISrvMonAppUnhandledMessageMessage, ISrvMonAppUnloadedMessage, ISrvMonAppUnloadedMessage, ISrvMonGetLoadedAppsRequest, ISrvMonGetLoadedAppsResponse, ISrvMonGetTraceHistoryRequest, ISrvMonGetTraceHistoryResponse, ISrvMonHeartbeatMessage, ISrvMonInvokeCommandRequest, ISrvMonInvokeCommandResponse, ISrvMonListCommandsRequest, ISrvMonListCommandsResponse, ISrvMonMessageBusBindingReconnectedMessage, ISrvMonMessageBusBindingReconnectingMessage, ISrvMonMessageTraceLoggingExceptionMessage, ISrvMonStartAppWatchCommand, ISrvMonStartTraceWatchRequest, ISrvMonStartTraceWatchResponse, ISrvMonStopAppWatchCommand, ISrvMonStopTraceWatchRequest, ISrvMonStopTraceWatchResponse, ISrvMonTraceRecord, ISrvMonUnhandledMessageMessage, ISrvMonXvmInfoRequest, ISrvMonXvmInfoResponse, MapMessageView

All Known Implementing Classes:

AepEnvironmentData, MessageViewImpl, RawMessageViewImpl, com.neeve.rog.impl.RogNode, SrvMonAppBusBindingCreatedMessage, SrvMonAppBusBindingCreateFailedMessage, SrvMonAppBusBindingCreateMessage, SrvMonAppBusBindingDestroyedMessage, SrvMonAppBusBindingDestroyMessage, SrvMonAppBusBindingDownMessage, SrvMonAppBusBindingOpenedMessage, SrvMonAppBusBindingOpenFailedMessage, SrvMonAppBusBindingOpeningMessage, SrvMonAppBusBindingStateChangeMessage, SrvMonAppBusBindingStateChangeMessage, SrvMonAppBusBindingUpMessage, SrvMonAppBusChannelClosedMessage, SrvMonAppBusChannelOpenedMessage, SrvMonAppChannelDownMessage, SrvMonAppChannelUpMessage, SrvMonAppClientConnectMessage, SrvMonAppClientConnectMessage, SrvMonAppClientDisconnectMessage, SrvMonAppClientDisconnectMessage, SrvMonAppDuplicateAcknowledgementAlertMessage, SrvMonAppEngineActiveMessage, SrvMonAppEngineCreatedMessage, SrvMonAppEngineStartedMessage, SrvMonAppEngineStoppedMessage, SrvMonAppEngineStoppingMessage, SrvMonAppExceptionMessage, SrvMonAppFlowCreateMessage, SrvMonAppFlowCreateMessage, SrvMonAppInboundLogExceptionMessage, SrvMonAppLoadedMessage, SrvMonAppLoadedMessage, SrvMonAppMessagingFailedMessage, SrvMonAppMessagingPrestartMessage, SrvMonAppMessagingStartedMessage, SrvMonAppMessagingStartFailedMessage, SrvMonAppOutboundLogExceptionMessage, SrvMonAppOutOfOrderSendCommitCompletionAlertMessage, SrvMonAppSendExceptionMessage, SrvMonAppStateChangeMessage, SrvMonAppStateChangeMessage, SrvMonAppStatsAlertMessage, SrvMonAppStoreBindingFailedMessage, SrvMonAppStoreBindingRoleChangedMessage, SrvMonAppStoreMemberDownMessage, SrvMonAppStoreMemberInitCompleteMessage, SrvMonAppStoreMemberUpMessage, SrvMonAppStoreTransactionLogRepairedMessage, SrvMonAppStuckAlertMessage, SrvMonAppUnhandledMessageMessage, SrvMonAppUnloadedMessage, SrvMonAppUnloadedMessage, SrvMonGetLoadedAppsRequest, SrvMonGetLoadedAppsResponse, SrvMonGetTraceHistoryRequest, SrvMonGetTraceHistoryResponse, SrvMonHeartbeatMessage, SrvMonInvokeCommandRequest, SrvMonInvokeCommandResponse, SrvMonListCommandsRequest, SrvMonListCommandsResponse, SrvMonMessageBusBindingReconnectedMessage, SrvMonMessageBusBindingReconnectingMessage, SrvMonMessageTraceLoggingExceptionMessage, SrvMonStartAppWatchCommand, SrvMonStartTraceWatchRequest, SrvMonStartTraceWatchResponse, SrvMonStopAppWatchCommand, SrvMonStopTraceWatchRequest, SrvMonStopTraceWatchResponse, SrvMonTraceRecord, SrvMonUnhandledMessageMessage, SrvMonXvmInfoRequest, SrvMonXvmInfoResponse
```
public interface MessageView
extends UtlReferenceTracker.HasReferenceTracker
```
Represents a view into a message.
From SMA's perspective, a message is just an object with a specific encoding e.g. a byte buffer, a hash table, an STO Container etc. A message view is an in-memory wrapper around a message that provides a specific view into the message contents. This interface defines the base class for all message views.

There are two views defined by SMA - the 'raw' view and the 'map' view. The raw view (defined by this interface) exposes the message as an object of a specific encoding type. No additional visibility is available with the raw view. The map view (defined by MapMessageView) enables a user, in addition to seeing the raw message, to view the message as a map i.e. a set of named fields.

Each message transported through SMA needs to be associated with a specific view. The user instantiates a view around a message and then hands the view over to one of SMAs send methods for delivery. The SMA send side machinery transports the underlying message as well as enough of information to reconsititute the send side message view on the receive side.

The SMA send and receive side machinery implement functionality conditional on the message view supplied. Some functionality requires the 'map' message view e.g. dynamic message key resolution. Functionality dependent on a specific message view will not be available for messages instantiated with message views not derived from the required message view.

Message views are instantiated by message view factories. View factories are configured with SMA (served by MessageViewFactoryRegistry). Each view factory has a system wide unique id. Each instantiated view is uniquely associated with one and only one factory. It is the id of the factory that a view is associated that is transported by SMA along with the message. On the receive side, the transported id is used to locate the appropriate factory that is invoked to reconstitute the view around the message.

Threading:

A message view is safe for concurrent read only access by multiple threads.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ENCODING_TYPE_CUSTOM` Identifies the user custom encoding type
`static int`	`ENCODING_TYPE_JSON` Identifies the 'JSON' message encoding
`static int`	`ENCODING_TYPE_PROTOBUF` Identifies the 'Protocol Buffer' message encoding
`static int`	`ENCODING_TYPE_QUARK` Identifies the 'Quark' message encoding
`static int`	`ENCODING_TYPE_XBUF` Identifies the 'X Buffer' message encoding
`static int`	`ENCODING_TYPE_XBUF2` Identifies the 'X Buffer 2' message encoding
`static int`	`NEXT_FREE_ENCODING_TYPE` Identifies the next free encoding type

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acquire()` Increase a message view's ownership count.
`MessageView`	`deserializeFromByteArray(byte[] serializedMessage)` Deserialize a view's backing message from a byte array.
`MessageView`	`deserializeFromByteBuffer(ByteBuffer serializedMessage)` Deserialize a view's backing message from a byte buffer.
`MessageView`	`deserializeFromJson(String serializedMessage)` Deserialize a view's backing message from a json string
`MessageView`	`deserializeFromPacket(PktPacket serializedMessage)` Deserialize a view's backing message from a packet.
`int`	`dispose()` Dispose a message view.
`long`	`getAppSendBeginTs()` Get's the time at which the application considers send for a message to start.
`long`	`getAppSendDoneTs()` Get's the time at which the application considers send for a message to be complete.
`long`	`getCreateTs()` Get a message's create timestamp.
`long`	`getEnqueueTs()` Get a message's enqueue timestamp in milliseconds
`long`	`getEnqueueTsMicros()` Get a message's enqueue timestamp This timestamp, in microseconds, specifies the time just before a message was enqueued on an application's input queue.
`Object`	`getMessage()` Get a view's backing message.
`String`	`getMessageBus()` Get the message bus name.
`XString`	`getMessageBusAsRaw()` Get the message bus in `XString` form.
`String`	`getMessageChannel()` Get the message channel name.
`XString`	`getMessageChannelAsRaw()` Get the message channel in `XString` form.
`int`	`getMessageEncodingType()` Get the message's encoding type.
`int`	`getMessageFlow()` Get the message flow.
`String`	`getMessageKey()` Get the message key.
`XString`	`getMessageKeyAsRaw()` Get the message key.
`int`	`getMessageSender()` Get the message sender.
`long`	`getMessageSequenceNumber()` Get the message sequence number.
`MessageTransportHeaders`	`getMessageTransportHeaders()` Returns the message's transport headers.
`long`	`getOriginTs()` Get a message's origin timestamp.
`long`	`getOutTs()` Get a message's out timestamp.
`long`	`getOutTsMicros()` Get a message's out timestamp in microseconds since the epoch.
`int`	`getOwnershipCount()` Get a message view's ownership count.
`long`	`getPostDeserializeTs()` Get a message's post-deserialize timestamp.
`long`	`getPostProcessingTs()` Deprecated. use `getPostProcessingTsMicros()` instead.
`long`	`getPostProcessingTsMicros()` Get a message's post-processing timestamp.
`long`	`getPostSerializeTs()` Get a message's post-serialize timestamp.
`long`	`getPostWireSendTs()` Get a message's post-wire timestamp.
`long`	`getPostWireTs()` Get a message's post-wire timestamp.
`long`	`getPreDeserializeTs()` Get a message's pre-deserialize timestamp.
`long`	`getPreProcessingTs()` Get a message's pre-processing timestamp.
`long`	`getPreProcessingTsMicros()` Get a message's pre-processing timestamp in microseconds.
`long`	`getPreSerializeTs()` Get a message's pre-serialize timestamp.
`long`	`getPreWireTs()` Get a message's pre-wire timestamp.
`long`	`getReceiveTs()` Get a message's receive timestamp.
`long`	`getSendStartTs()` Get a message's send timestamp.
`long`	`getSendTs()` Get a message's send timestamp.
`Object`	`getTag(int id)` Get a message view tag.
`short`	`getType()` Get the view type.
`short`	`getVfid()` Get the view factory identifier.
`boolean`	`isPossibleDuplicate()` Get whether a message is a possible duplicate..
`void`	`resolveMessageKeyWith(MessageChannelKeyResolver keyResolver, MessageChannel.RawKeyResolutionTable keyResolutionTable)` Set the message key for this message using the provided keyResolver and keyResolutionTable.
`void`	`resolveMessageKeyWith(MessageChannelKeyResolver keyResolver, Properties keyResolutionTable)` Set the message key for this message using the provided keyResolver and keyResolutionTable.
`byte[]`	`serializeToByteArray()` Serialize a view's backing message to a byte array.
`ByteBuffer`	`serializeToByteBuffer()` Serialize a view's backing message to a byte buffer.
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)` Serializes the `MessageView` to an IOBuffer.
`String`	`serializeToJson()` Serialize a view's backing message to JSON.
`PktPacket`	`serializeToPacket()` Serialize a view's backing message to a packet.
`MessageView`	`setAppSendBeginTs(long ts)` Time at which the application considers send for a message to start.
`MessageView`	`setAppSendDoneTs(long ts)` Set's the time at which the application considers send for a message to be complete.
`MessageView`	`setCreateTs(long ts)` Set a message's create timestamp.
`MessageView`	`setEnqueueTsMicros(long ts)` Sets a message's enqueue timestamp This timestamp, in microseconds, specifies the time just before a message was enqueued on an application's input queue.
`MessageView`	`setMessageBus(String name)` Set the message bus name.
`MessageView`	`setMessageBusAsRaw(XString bus)` Set the message bus.
`MessageView`	`setMessageChannel(String name)` Set the message channel name.
`MessageView`	`setMessageChannelAsRaw(XString channel)` Set the message channel.
`MessageView`	`setMessageFlow(int flow)` Set the message flow.
`MessageView`	`setMessageKey(String key)` Set the message key.
`MessageView`	`setMessageKeyAsRaw(XString key)` Set the message key.
`MessageView`	`setMessageSender(int sender)` Set the message sender.
`MessageView`	`setMessageSequenceNumber(long sno)` Set the message sequence number.
`MessageView`	`setMessageTransportHeaders(MessageTransportHeaders headers)` Copies the provided transport headers into this message.
`MessageView`	`setOriginTs(long ts)` Set a message's origin timestamp.
`MessageView`	`setOutTs(long ts)` Deprecated. Use `setOutTsMicros(long)` instead
`MessageView`	`setOutTsMicros(long ts)` Set a message's out timestamp in microseconds since the epoch.
`MessageView`	`setPossibleDuplicate()` Set a message as a possible duplicate.
`MessageView`	`setPostDeserializeTs(long ts)` Set a message's post-deserialize timestamp.
`MessageView`	`setPostProcessingTs(long ts)` Deprecated. use `setPostProcessingTsMicros(long)` instead.
`MessageView`	`setPostProcessingTsMicros(long ts)` Set a message's post-processing timestamp.
`MessageView`	`setPostSerializeTs(long ts)` Set a message's post-serialize timestamp.
`MessageView`	`setPostWireSendTs(long ts)` Set a message's post-wire send timestamp.
`MessageView`	`setPostWireTs(long ts)` Set a message's post-wire timestamp.
`MessageView`	`setPreDeserializeTs(long ts)` Set a message's pre-deserialize timestamp.
`MessageView`	`setPreProcessingTs(long ts)` Deprecated. To prevent loss of timestamp precision use `setPreProcessingTsMicros(long)` instead.
`MessageView`	`setPreProcessingTsMicros(long ts)` Set a message's pre-processing timestamp in microseconds.
`MessageView`	`setPreSerializeTs(long ts)` Set a message's pre-serialize timestamp.
`MessageView`	`setPreWireTs(long ts)` Set a message's pre-wire timestamp.
`MessageView`	`setReceiveTs(long ts)` Set a message's receive timestamp.
`MessageView`	`setSendStartTs(long ts)` Set a message's send timestamp.
`MessageView`	`setSendTs(long ts)` Set a message's send timestamp.
`void`	`setTag(int id, Object tag)` Set a message view tag.
`void`	`sync()` Ensure a view's backing message is prepared and ready for transport

Methods inherited from interface com.neeve.util.UtlReferenceTracker.HasReferenceTracker
referenceTracker

- Field Detail
  - ENCODING_TYPE_CUSTOM
```
static final int ENCODING_TYPE_CUSTOM
```
    Identifies the user custom encoding type
    
    See Also:
    Constant Field Values
  - ENCODING_TYPE_QUARK
```
static final int ENCODING_TYPE_QUARK
```
    Identifies the 'Quark' message encoding
    
    See Also:
    Constant Field Values
  - ENCODING_TYPE_XBUF
```
static final int ENCODING_TYPE_XBUF
```
    Identifies the 'X Buffer' message encoding
    
    See Also:
    Constant Field Values
  - ENCODING_TYPE_XBUF2
```
static final int ENCODING_TYPE_XBUF2
```
    Identifies the 'X Buffer 2' message encoding
    
    See Also:
    Constant Field Values
  - ENCODING_TYPE_PROTOBUF
```
static final int ENCODING_TYPE_PROTOBUF
```
    Identifies the 'Protocol Buffer' message encoding
    
    See Also:
    Constant Field Values
  - ENCODING_TYPE_JSON
```
static final int ENCODING_TYPE_JSON
```
    Identifies the 'JSON' message encoding
    
    See Also:
    Constant Field Values
  - NEXT_FREE_ENCODING_TYPE
```
static final int NEXT_FREE_ENCODING_TYPE
```
    Identifies the next free encoding type
    
    See Also:
    Constant Field Values
- Method Detail
  - setTag
```
void setTag(int id,
          Object tag)
```
    Set a message view tag.
    
    Threading:
    
    This method is not safe for concurrent access by multiple threads with itself or with getTag(int)
    A message view tag is an opaque object that can be tagged to a message view object. Each tag is uniquely identified in the system via a numeric value View tag ids reserved for internal use by the X Platform are defined in MessageViewTags.
  - getTag
```
Object getTag(int id)
```
    Get a message view tag.
    
    Returns:
    Returns the requested tag
    Threading:
    
    This method is not safe for concurrent access by multiple threads with itself or with setTag(int, java.lang.Object)
  - getVfid
```
short getVfid()
```
    Get the view factory identifier.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
    This method returns the system wide unique identifier of the view factory that instantiated this message view.
  - getType
```
short getType()
```
    Get the view type.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
    A message view type uniquely identifies a message within its factory.
  - getMessageEncodingType
```
int getMessageEncodingType()
```
    Get the message's encoding type.
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
    This method returns a message's encoding type.
  - setMessageBus
```
MessageView setMessageBus(String name)
```
    Set the message bus name.
    
    Parameters:
    name - The message bus name to set.
    
    Returns:
    Returns this for invocation chaining.
  - getMessageBus
```
String getMessageBus()
```
    Get the message bus name.
    This method returns the bus associated with a message.
  - setMessageBusAsRaw
```
MessageView setMessageBusAsRaw(XString bus)
```
    Set the message bus.
    
    Parameters:
    bus - The message bus to set.
    
    Returns:
    Returns this for invocation chaining.
  - getMessageBusAsRaw
```
XString getMessageBusAsRaw()
```
    Get the message bus in XString form.
    For a received message, the bus name is set on the message using via the message bus bus binding that received it. For performance reasons a message bus implementation may not set the channel name on a received message unless it is configured to do so.
    For a sent message the bus name would typically be set by the sending application when the message is sent.
    
    See Also:
    Note that it is not safe to hold onto a reference to the returned XString as it is pooled with the underling message., getMessageBus()
  - setMessageChannel
```
MessageView setMessageChannel(String name)
```
    Set the message channel name.
    
    Parameters:
    name - The message channel name to set.
    
    Returns:
    Returns this for invocation chaining.
  - getMessageChannel
```
String getMessageChannel()
```
    Get the message channel name.
    This method returns the channel associated with a message.
    For a received message, the channel name is set on the message using the channel that was resolved by the message bus binding that received it. For performance reasons a message bus implementation may not set the channel name on a received message unless it is configured to do so.
    For a sent message the channel name would typically be set by the sending application when the message is sent.
    
    See Also:
    MessageBusBinding.PROP_SET_BUS_AND_CHANNEL_ON_RECEIPT, getMessageChannelAsRaw()
  - setMessageChannelAsRaw
```
MessageView setMessageChannelAsRaw(XString channel)
```
    Set the message channel.
    
    Parameters:
    channel - The message channel to set.
    
    Returns:
    Returns this for invocation chaining.
  - getMessageChannelAsRaw
```
XString getMessageChannelAsRaw()
```
    Get the message channel in XString form.
    This method returns the channel associated with a message.
    Note that it is not safe to hold onto a reference to the returned XString as it is pooled with the underling message.
    
    See Also:
    getMessageChannel()
  - setMessageKey
```
MessageView setMessageKey(String key)
```
    Set the message key.
    
    Parameters:
    key - The message key to set.
    
    Returns:
    Returns this for invocation chaining.
  - resolveMessageKeyWith
```
void resolveMessageKeyWith(MessageChannelKeyResolver keyResolver,
                         Properties keyResolutionTable)
                           throws SmaException
```
    Set the message key for this message using the provided keyResolver and keyResolutionTable.
    This method can be more efficient than first resolving the key using the key resolver and setting it on the message, because the message view implementation can potentially resolve the key directly into the backing buffer rather than having to copy it from a key resolved first through the key resolver.
    This method is not necessarily zero garbage. For zero garbage key resolution use #resolveMessageKeyWith(MessageChannelKeyResolver, RawKeyResolutionTable)
    
    Parameters:
    keyResolver - The message key resolver used to build the key.
    keyResolutionTable - The key resolution table.
    
    Throws:
    
    SmaException - If there is an error in key resolution.
    See Also:
    MessageChannelKeyResolver.resolveMessageKey(MessageView, Properties)
    Threading:
    
    This method is s not safe for concurrent access by multiple threads
  - getMessageKey
```
String getMessageKey()
```
    Get the message key.
    This method returns the key associated with a message.
    
    See Also:
    MessageBusBinding.PROP_SET_KEY_ON_RECEIPT
  - setMessageKeyAsRaw
```
MessageView setMessageKeyAsRaw(XString key)
```
    Set the message key.
    
    Parameters:
    key - The message key to set.
    
    Returns:
    Returns this for invocation chaining.
  - resolveMessageKeyWith
```
void resolveMessageKeyWith(MessageChannelKeyResolver keyResolver,
                         MessageChannel.RawKeyResolutionTable keyResolutionTable)
                           throws SmaException
```
    Set the message key for this message using the provided keyResolver and keyResolutionTable.
    This method can be more efficient than first resolving the key using the key resolver and setting it on the message, because the message view implementation can potentially resolve the key directly into the backing buffer rather than having to copy it from a key resolved first through the key resolver.
    
    Parameters:
    keyResolver - The message key resolver used to build the key.
    keyResolutionTable - The key resolution table.
    
    Throws:
    
    SmaException - If there is an error in key resolution.
    See Also:
    MessageChannelKeyResolver#resolveMessageKey(XString, MessageView, RawKeyResolutionTable)
    Threading:
    
    This method is not safe for concurrent access by multiple threads
  - getMessageKeyAsRaw
```
XString getMessageKeyAsRaw()
```
    Get the message key.
    This method returns the key associated with a message.
    Note that it is not safe to hold onto a reference to the returned XString as it is pooled with the underling message.
    
    See Also:
    getMessageKey()
  - setMessageSender
```
MessageView setMessageSender(int sender)
```
    Set the message sender.
    
    Parameters:
    sender - The message sender to set
    
    Returns:
    Returns this for invocation chaining.
  - getMessageSender
```
int getMessageSender()
```
    Get the message sender.
    This method returns the system-wide unique sender id. Sequence numbers returned by getMessageSequenceNumber() are scoped by sender.
  - getMessageTransportHeaders
```
MessageTransportHeaders getMessageTransportHeaders()
```
    Returns the message's transport headers.
    Message transport headers store generic name/value pairs that are specific to a concrete messaging provider. Each message bus binding will typically support a different set of transport headers. On receipt of a message the binding pulls values off of the native message type and stores them in the transport header. For sent messages a binding implementation may support propagating values set in the transport header on the underlying native message type.
    
    Returns:
    The message transport headers or null if transport headers are disabled, not present, or unsupported by the MessageView
  - setMessageTransportHeaders
```
MessageView setMessageTransportHeaders(MessageTransportHeaders headers)
```
    Copies the provided transport headers into this message.
    
    Parameters:
    headers - The headers to set on the message (or null to clear the transport headers).
    
    Returns:
    Returns this for invocation chaining.
  - setMessageFlow
```
MessageView setMessageFlow(int flow)
```
    Set the message flow.
    
    Parameters:
    flow - The message flow to set.
    
    Returns:
    Returns this for invocation chaining.
  - getMessageFlow
```
int getMessageFlow()
```
    Get the message flow.
    This method returns the system-wide unique flow id. Flows define the order in which messages need to be processed.
  - setMessageSequenceNumber
```
MessageView setMessageSequenceNumber(long sno)
```
    Set the message sequence number.
    
    Parameters:
    sno - The sequence number to set.
    
    Returns:
    Returns this for invocation chaining.
  - getMessageSequenceNumber
```
long getMessageSequenceNumber()
```
    Get the message sequence number.
    This method returns the sender scoped message sequence number.
  - setPossibleDuplicate
```
MessageView setPossibleDuplicate()
```
    Set a message as a possible duplicate.
    
    Returns:
    Returns this for invocation chaining.
  - isPossibleDuplicate
```
boolean isPossibleDuplicate()
```
    Get whether a message is a possible duplicate..
  - setOriginTs
```
MessageView setOriginTs(long ts)
```
    Set a message's origin timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getOriginTs
```
long getOriginTs()
```
    Get a message's origin timestamp.
    This timestamp, in microseconds, specifies the time at which the first message in this message's flow originated.
    
    Returns:
    Returns the origin timestamp. A value of zero indicates that the origin timestamp was not recorded.
  - setCreateTs
```
MessageView setCreateTs(long ts)
```
    Set a message's create timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getCreateTs
```
long getCreateTs()
```
    Get a message's create timestamp.
    This timestamp, in microseconds, specifies the time at which the message was created or, if the message is pooled, the time at which the message was resuscitated from its pool.
    
    Returns:
    Returns the create timestamp. A value of zero indicates that the create timestamp was not recorded.
  - setAppSendBeginTs
```
MessageView setAppSendBeginTs(long ts)
```
    Time at which the application considers send for a message to start.
    
    Parameters:
    ts - The application's send start timestamp.
    
    Returns:
    Returns this for invocation chaining.
  - getAppSendBeginTs
```
long getAppSendBeginTs()
```
    Get's the time at which the application considers send for a message to start.
    This timestamp, in microseconds, specifies the time at which the send started from from the application's view point. This timestamp is the same as outTs unless an application explicitly sets it to an earlier value.
    
    Returns:
    The application's send start timestamp.
  - setAppSendDoneTs
```
MessageView setAppSendDoneTs(long ts)
```
    Set's the time at which the application considers send for a message to be complete.
    
    Returns:
    The application's send start timestamp.
  - getAppSendDoneTs
```
long getAppSendDoneTs()
```
    Get's the time at which the application considers send for a message to be complete.
    This timestamp, in microseconds, specifies the time at which the send completes from an application's perspective. If the message is sent in the background this value can be lower even the getSendStartTs()
    
    Returns:
    Returns this for invocation chaining.
  - setSendTs
```
MessageView setSendTs(long ts)
```
    Set a message's send timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getSendTs
```
long getSendTs()
```
    Get a message's send timestamp.
    This timestamp, in microseconds, specifies the time at which the message was offered to the bus for begin the send.
    
    Returns:
    Returns the send timestamp. A value of zero indicates that the outbound timestamp was not recorded.
  - setSendStartTs
```
MessageView setSendStartTs(long ts)
```
    Set a message's send timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getSendStartTs
```
long getSendStartTs()
```
    Get a message's send timestamp.
    This timestamp, in microseconds, specifies the time at which the message was offered to the bus for send.
    
    Returns:
    Returns the send timestamp. A value of zero indicates that the outbound timestamp was not recorded.
  - setOutTs
```
@Deprecated
MessageView setOutTs(long ts)
```
    Deprecated. Use setOutTsMicros(long) instead
    
    Set a message's out timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getOutTs
```
long getOutTs()
```
    Get a message's out timestamp.
    This timestamp is the same as getOutTsMicros() / 1000.
    
    Returns:
    Returns the out timestamp. A value of zero indicates that the outbound timestamp was not recorded.
    See Also:
    getOutTsMicros()
  - setOutTsMicros
```
MessageView setOutTsMicros(long ts)
```
    Set a message's out timestamp in microseconds since the epoch.
    It is expected that this field will be set via a value obtained from UtlTime#nowSinceEpoch()
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
    See Also:
    UtlTime.nowSinceEpoch()
  - getOutTsMicros
```
long getOutTsMicros()
```
    Get a message's out timestamp in microseconds since the epoch.
    This timestamp is the same timestamp as which an application called send to initiate the send for the message.
    
    Note that this timestamp is not the timestamp at which a message is actually written to the wire for delivery. A sent message is queued for delivery until the transaction that is is part of is committed.
    
    Returns:
    Returns the out timestamp. A value of zero indicates that the outbound timestamp was not recorded.
  - setPreSerializeTs
```
MessageView setPreSerializeTs(long ts)
```
    Set a message's pre-serialize timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPreSerializeTs
```
long getPreSerializeTs()
```
    Get a message's pre-serialize timestamp.
    This timestamp, in microseconds, specifies the time just before a message was serialized for transport.
    
    Returns:
    Returns the timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - setPostSerializeTs
```
MessageView setPostSerializeTs(long ts)
```
    Set a message's post-serialize timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPostSerializeTs
```
long getPostSerializeTs()
```
    Get a message's post-serialize timestamp.
    This timestamp, in microseconds, specifies the time just after a message was serialized for transport.
    
    Returns:
    Returns the timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - setPreWireTs
```
MessageView setPreWireTs(long ts)
```
    Set a message's pre-wire timestamp.
    This timestamp, in microseconds, specifies the time just before a message was sent on the network (the accuracy of this depends on how close to the wire the SMA binding used can timestamp the message)
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPreWireTs
```
long getPreWireTs()
```
    Get a message's pre-wire timestamp.
    This timestamp, in microseconds, specifies the time just before a message was sent on the network (the accuracy of this depends on how close to the wire the SMA binding used can timestamp the message).
    The returned timestamp is in microseconds.
    
    Returns:
    Returns the timestamp. A value of zero indicates that the outbound timestamp was not recorded.
  - setPostWireSendTs
```
MessageView setPostWireSendTs(long ts)
```
    Set a message's post-wire send timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPostWireSendTs
```
long getPostWireSendTs()
```
    Get a message's post-wire timestamp.
    This timestamp, in microseconds, specifies the time just after the bus provider specific network send call returns. Comparing this timestamp to getPreWireTs() determines the time spent in the bus provider's send call.
    
    Returns:
    Returns the timestamp. A value of zero indicates that the timestamp was not recorded.
  - setPostWireTs
```
MessageView setPostWireTs(long ts)
```
    Set a message's post-wire timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPostWireTs
```
long getPostWireTs()
```
    Get a message's post-wire timestamp.
    This timestamp, in microseconds, specifies the time just after a message was received from the network (the accuracy of this depends on how close to the wire the SMA binding used can timestamp the message)
    
    Returns:
    Returns the timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - setPreDeserializeTs
```
MessageView setPreDeserializeTs(long ts)
```
    Set a message's pre-deserialize timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPreDeserializeTs
```
long getPreDeserializeTs()
```
    Get a message's pre-deserialize timestamp.
    This timestamp, in microseconds, specifies the time just before a message was de-serialized after transport.
    
    Returns:
    Returns the timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - setPostDeserializeTs
```
MessageView setPostDeserializeTs(long ts)
```
    Set a message's post-deserialize timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPostDeserializeTs
```
long getPostDeserializeTs()
```
    Get a message's post-deserialize timestamp.
    This timestamp, in microseconds, specifies the time just after a message was de-serialized after transport.
    
    Returns:
    Returns the timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - setReceiveTs
```
MessageView setReceiveTs(long ts)
```
    Set a message's receive timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getReceiveTs
```
long getReceiveTs()
```
    Get a message's receive timestamp.
    This timestamp, in microseconds, specifies the time just before a message was received by X's application dispatch machinery. It is the same as the pre-processing timestamp if the message is not being redelivered to the application by the in-process X runtime.
    
    Returns:
    Returns the in timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - getEnqueueTs
```
long getEnqueueTs()
```
    Get a message's enqueue timestamp in milliseconds
    
    Returns:
    Returns the enqueue timestamp. A value of zero indicates that the inbound timestamp was not recorded.
    See Also:
    getEnqueueTsMicros()
  - setEnqueueTsMicros
```
MessageView setEnqueueTsMicros(long ts)
```
    Sets a message's enqueue timestamp
    This timestamp, in microseconds, specifies the time just before a message was enqueued on an application's input queue.
    
    Parameters:
    ts - the enqueue timestamp in microseconds.
  - getEnqueueTsMicros
```
long getEnqueueTsMicros()
```
    Get a message's enqueue timestamp
    This timestamp, in microseconds, specifies the time just before a message was enqueued on an application's input queue.
    This timestamp can be compared with getPreProcessingTsMicros() to determine the amount of time that the message spent on an application's input queue unless the application is configured to use Event Sourcing and the message is one re-enqueued during recovery from a transaction or received by a backup instance via replication.
    
    Returns:
    Returns the enqueueTs timestamp. A value of zero indicates that the inbound timestamp was not recorded.
  - setPreProcessingTs
```
@Deprecated
MessageView setPreProcessingTs(long ts)
```
    Deprecated. To prevent loss of timestamp precision use setPreProcessingTsMicros(long) instead.
    
    Set a message's pre-processing timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPreProcessingTs
```
long getPreProcessingTs()
```
    Get a message's pre-processing timestamp.
    This timestamp is the same as getPreProcessingTsMicros() / 1000.
    
    Returns:
    Returns the timestamp just before the message was dispatched into the application for processing. A value of zero indicates that the pre-processing timestamp was not recorded.
    See Also:
    getPreProcessingTsMicros()
  - setPreProcessingTsMicros
```
MessageView setPreProcessingTsMicros(long ts)
```
    Set a message's pre-processing timestamp in microseconds.
    It is expected that this field will be set via a value obtained from UtlTime#nowSinceEpoch()
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
    See Also:
    UtlTime.nowSinceEpoch()
  - getPreProcessingTsMicros
```
long getPreProcessingTsMicros()
```
    Get a message's pre-processing timestamp in microseconds.
    This timestamp records the time just before a message was dispatched to the application for processing.
    Because the pre-processing timestamp is used to provide HA consistent time for an application that is using Event Sourcing as an HaPolicy, this value is guaranteed to be set to the same value as used on the primary instance. A backup instance or a primary recovering from a transaciton log will see the original preProcessingTs value.
    
    Returns:
    Returns the timestamp just before the message was dispatched into the application for processing. A value of zero indicates that the pre-processing timestamp was not recorded.
  - setPostProcessingTs
```
@Deprecated
MessageView setPostProcessingTs(long ts)
```
    Deprecated. use setPostProcessingTsMicros(long) instead.
    
    Set a message's post-processing timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPostProcessingTs
```
@Deprecated
long getPostProcessingTs()
```
    Deprecated. use getPostProcessingTsMicros() instead.
    
    Get a message's post-processing timestamp.
    This timestamp, in milliseconds, specifies the time just after a message processing handler completes.
    
    Returns:
    Returns the timestamp just after the message was processed by the application. A value of zero indicates that the post-processing timestamp was not recorded.
  - setPostProcessingTsMicros
```
MessageView setPostProcessingTsMicros(long ts)
```
    Set a message's post-processing timestamp.
    
    Parameters:
    ts - The timestamp to set.
    
    Returns:
    Returns this for invocation chaining.
  - getPostProcessingTsMicros
```
long getPostProcessingTsMicros()
```
    Get a message's post-processing timestamp.
    This timestamp, in microseconds, specifies the time just after a message processing handler completes.
    
    Returns:
    Returns the timestamp just after the message was processed by the application. A value of zero indicates that the post-processing timestamp was not recorded.
  - getMessage
```
Object getMessage()
```
    Get a view's backing message.
    This method returns the actual message wrapped by the view. It is the message that is transported
    
    Threading:
    
    This method is safe for concurrent access by multiple threads
  - sync
```
void sync()
```
    Ensure a view's backing message is prepared and ready for transport
  - serializeToByteArray
```
byte[] serializeToByteArray()
```
    Serialize a view's backing message to a byte array.
  - serializeToByteBuffer
```
ByteBuffer serializeToByteBuffer()
```
    Serialize a view's backing message to a byte buffer.
  - serializeToIOBuffer
```
com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
```
    Serializes the MessageView to an IOBuffer.
    Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.
    The buffer backing the IOBuffer should be flipped (ready for read) upon return.
    
    Parameters:
    useNative - Whether the returned buffer should be native.
    
    Returns:
    The MessageView serialized to an IOBuffer.
  - serializeToPacket
```
PktPacket serializeToPacket()
```
    Serialize a view's backing message to a packet.
  - serializeToJson
```
String serializeToJson()
```
    Serialize a view's backing message to JSON.
    Serializing/deserializing a message to/from JSON is an optional operation
  - deserializeFromByteArray
```
MessageView deserializeFromByteArray(byte[] serializedMessage)
```
    Deserialize a view's backing message from a byte array.
    
    Parameters:
    serializedMessage - The view's backing message serialized as a byte array.
  - deserializeFromByteBuffer
```
MessageView deserializeFromByteBuffer(ByteBuffer serializedMessage)
```
    Deserialize a view's backing message from a byte buffer.
    
    Parameters:
    serializedMessage - The view's backing message serialized as a byte buffer.
  - deserializeFromPacket
```
MessageView deserializeFromPacket(PktPacket serializedMessage)
```
    Deserialize a view's backing message from a packet.
    
    Parameters:
    serializedMessage - The view's backing message serialized as a packet.
  - deserializeFromJson
```
MessageView deserializeFromJson(String serializedMessage)
```
    Deserialize a view's backing message from a json string
    
    Parameters:
    serializedMessage - The view's backing message serialized as a json string.
    Serializing/deserializing a message to/from JSON is an optional operation
  - acquire
```
void acquire()
```
    Increase a message view's ownership count.
    This method increments a message view's ownership count. View ownership is used in conjunction with managing message view pools. If a view is tagged to an object pool, the packet is released back to the pool by dispose() when the ownership count reduces to 0. If not tagged to a pool, change of ownership count has no side effects.
    
    A packet's ownership count starts at 1.
  - getOwnershipCount
```
int getOwnershipCount()
```
    Get a message view's ownership count.
  - dispose
```
int dispose()
```
    Dispose a message view.
    This method should be invoked by the user when done with a message view. It decrements the view's ownership count and releases it to its object pool if one is tagged to it and this method cause the ownership count to reduce to zero. If not tagged to a pool, ownership change methods have no side effects aside from just updating the ownership counter.
    
    Once disposed, all references to the disposed view should be discarded.

Interface MessageView

Field Summary

Method Summary

Methods inherited from interface com.neeve.util.UtlReferenceTracker.HasReferenceTracker

Field Detail

ENCODING_TYPE_CUSTOM

ENCODING_TYPE_QUARK

ENCODING_TYPE_XBUF

ENCODING_TYPE_XBUF2

ENCODING_TYPE_PROTOBUF

ENCODING_TYPE_JSON

NEXT_FREE_ENCODING_TYPE

Method Detail

setTag

getTag

getVfid

getType

getMessageEncodingType

setMessageBus

getMessageBus

setMessageBusAsRaw

getMessageBusAsRaw

setMessageChannel

getMessageChannel

setMessageChannelAsRaw

getMessageChannelAsRaw

setMessageKey

resolveMessageKeyWith

getMessageKey

setMessageKeyAsRaw

resolveMessageKeyWith

getMessageKeyAsRaw

setMessageSender

getMessageSender

getMessageTransportHeaders

setMessageTransportHeaders

setMessageFlow

getMessageFlow

setMessageSequenceNumber

getMessageSequenceNumber

setPossibleDuplicate

isPossibleDuplicate

setOriginTs

getOriginTs

setCreateTs

getCreateTs

setAppSendBeginTs

getAppSendBeginTs

setAppSendDoneTs

getAppSendDoneTs

setSendTs

getSendTs

setSendStartTs

getSendStartTs

setOutTs

getOutTs

setOutTsMicros

getOutTsMicros

setPreSerializeTs

getPreSerializeTs

setPostSerializeTs

getPostSerializeTs

setPreWireTs

getPreWireTs

setPostWireSendTs

getPostWireSendTs

setPostWireTs

getPostWireTs

setPreDeserializeTs

getPreDeserializeTs

setPostDeserializeTs

getPostDeserializeTs

setReceiveTs

getReceiveTs

getEnqueueTs

setEnqueueTsMicros

getEnqueueTsMicros

setPreProcessingTs

getPreProcessingTs

setPreProcessingTsMicros