MessageViewImpl (Talon 3.16.63 API)

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

All Implemented Interfaces:

MessageView, UtlReferenceTracker.HasReferenceTracker

Direct Known Subclasses:

RawMessageViewImpl, com.neeve.rog.impl.RogNode
```
public abstract class MessageViewImpl
extends UtlListElement
implements MessageView
```
Base class implementation of a message view.

Field Summary
- Fields inherited from class com.neeve.util.UtlListElement
  count, head, next, prev
- Fields inherited from interface com.neeve.sma.MessageView
  ENCODING_TYPE_CUSTOM, ENCODING_TYPE_JSON, ENCODING_TYPE_PROTOBUF, ENCODING_TYPE_QUARK, ENCODING_TYPE_XBUF, ENCODING_TYPE_XBUF2, NEXT_FREE_ENCODING_TYPE

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquire()` Implementation of `MessageView.acquire()`
`MessageView`	`deserializeFrom(byte[] array, int offset, int len)` Default implementation of `MessageView.deserializeFrom(byte[], int, int)`
`MessageView`	`deserializeFrom(ByteBuffer buffer)` Default implementation of `MessageView.deserializeFrom(ByteBuffer)`
`MessageView`	`deserializeFrom(com.neeve.io.IOBuffer buffer, int offset, int len)` Default implementation of `MessageView.deserializeFrom(IOBuffer, int, int)`
`MessageView`	`deserializeFrom(com.neeve.io.IOElasticBuffer buffer, int offset, int len)` Default implementation of `MessageView.deserializeFrom(IOElasticBuffer, int, int)`
`MessageView`	`deserializeFrom(long addr, int offset, int len)` Default implementation of `MessageView.deserializeFrom(long, int, int)`
`MessageView`	`deserializeFrom(PktPacket packet)` Default implementation of `MessageView.deserializeFrom(PktPacket)`
`int`	`dispose()` Default implementation of `MessageView.dispose()` This is the default implementation of the dispose method.
`Object`	`getMessage()` Implementation of `MessageView.getMessage()`
`int`	`getMessageEncodingType()` Implementation of `MessageView.getMessageEncodingType()`
`MessageTransportHeaders`	`getMessageTransportHeaders()` Implementation of `MessageView.getMessageTransportHeaders()`
`int`	`getOwnershipCount()` Implementation of `MessageView.getOwnershipCount()`
`Object`	`getTag(int id)` Implementation of `MessageView.getTag(int)`
`short`	`getType()` Implementation of `MessageView.getType()`
`short`	`getVfid()` Implementation of `MessageView.getVfid()`
`UtlReferenceTracker`	`referenceTracker()` Implementation of `UtlReferenceTracker.HasReferenceTracker.referenceTracker()`
`void`	`saveMemory()` Default implementation of `MessageView.saveMemory()`
`int`	`serializeTo(byte[] array, int offset)` Default implementation of `MessageView.serializeTo(byte[], int)`
`int`	`serializeTo(ByteBuffer buffer)` Default implementation of `MessageView.serializeTo(ByteBuffer)`
`int`	`serializeTo(com.neeve.io.IOBuffer buffer, int offset)` Default implementation of `MessageView.serializeTo(IOBuffer, int)`
`int`	`serializeTo(com.neeve.io.IOElasticBuffer buffer, int offset)` Default implementation of `MessageView.serializeTo(IOElasticBuffer, int)`
`int`	`serializeTo(long addr, int offset)` Default implementation of `MessageView.serializeTo(long , int )`
`int`	`serializeTo(PktPacket packet)` Default implementation of `MessageView.serializeTo(PktPacket)`
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)` Default implementation of `MessageView.serializeToIOBuffer(boolean)`
`MessageView`	`setMessageTransportHeaders(MessageTransportHeaders headers)` Implementation of `MessageView.setMessageTransportHeaders(com.neeve.sma.MessageTransportHeaders)`
`void`	`setTag(int id, Object tag)` Implementation of `MessageView.setTag(int, java.lang.Object)`
`String`	`toString()` Return a string representation of this object

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

Methods inherited from interface com.neeve.sma.MessageView
deserializeFromByteArray, deserializeFromByteBuffer, deserializeFromJson, deserializeFromPacket, getAppSendBeginTs, getAppSendDoneTs, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageSender, getMessageSequenceNumber, getOriginTs, getOutTs, getOutTsMicros, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, isPossibleDuplicate, resolveMessageKeyWith, resolveMessageKeyWith, serializeToByteArray, serializeToByteBuffer, serializeToJson, serializeToPacket, setAppSendBeginTs, setAppSendDoneTs, setCreateTs, setEnqueueTsMicros, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setOriginTs, setOutTs, setOutTsMicros, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, sync

- Method Detail
  - setTag
```
public final void setTag(int id,
                         Object tag)
```
    Implementation of MessageView.setTag(int, java.lang.Object)
    
    Specified by:
    
    setTag in interface MessageView
  - getTag
```
public final Object getTag(int id)
```
    Implementation of MessageView.getTag(int)
    
    Specified by:
    
    getTag in interface MessageView
    
    Returns:
    
    Returns the requested tag
  - getVfid
```
public final short getVfid()
```
    Implementation of MessageView.getVfid()
    
    Specified by:
    
    getVfid in interface MessageView
  - getType
```
public final short getType()
```
    Implementation of MessageView.getType()
    
    Specified by:
    
    getType in interface MessageView
  - getMessageEncodingType
```
public final int getMessageEncodingType()
```
    Implementation of MessageView.getMessageEncodingType()
    
    Specified by:
    
    getMessageEncodingType in interface MessageView
  - getMessageTransportHeaders
```
public MessageTransportHeaders getMessageTransportHeaders()
```
    Implementation of MessageView.getMessageTransportHeaders()
    
    Specified by:
    
    getMessageTransportHeaders in interface MessageView
    
    Returns:
    
    The message transport headers or null if transport headers are disabled, not present, or not supported by the MessageView
  - setMessageTransportHeaders
```
public MessageView setMessageTransportHeaders(MessageTransportHeaders headers)
```
    Implementation of MessageView.setMessageTransportHeaders(com.neeve.sma.MessageTransportHeaders)
    
    Specified by:
    
    setMessageTransportHeaders in interface MessageView
    
    Parameters:
    
    headers - The headers to set on the message (or null to clear the transport headers).
    
    Returns:
    
    Returns this for invocation chaining.
  - getMessage
```
public final Object getMessage()
```
    Implementation of MessageView.getMessage()
    
    Specified by:
    
    getMessage in interface MessageView
  - serializeTo
```
public int serializeTo(byte[] array,
                       int offset)
```
    Default implementation of MessageView.serializeTo(byte[], int)
    
    Specified by:
    
    serializeTo in interface MessageView
    
    Parameters:
    
    array - The array to serialize the message to
    
    offset - Offset into the array to serialize the message to
    
    Returns:
    
    The number of bytes serialized to the supplied byte array
  - serializeTo
```
public int serializeTo(ByteBuffer buffer)
```
    Default implementation of MessageView.serializeTo(ByteBuffer)
    
    Specified by:
    
    serializeTo in interface MessageView
    
    Parameters:
    
    buffer - The buffer to serialize to
    
    Returns:
    
    The number of bytes serialized to the byte buffer
  - serializeToIOBuffer
```
public com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
```
    Default implementation of MessageView.serializeToIOBuffer(boolean)
    
    Specified by:
    
    serializeToIOBuffer in interface MessageView
    
    Parameters:
    
    useNative - Whether the returned buffer should be native.
    
    Returns:
    
    A freshly created IO buffer containing the serialized message
  - serializeTo
```
public int serializeTo(com.neeve.io.IOBuffer buffer,
                       int offset)
```
    Default implementation of MessageView.serializeTo(IOBuffer, int)
    
    Specified by:
    
    serializeTo in interface MessageView
    
    Parameters:
    
    buffer - The buffer to serialize the message to
    
    offset - The offset into the buffer to serialize the message
    
    Returns:
    
    The number of bytes serialized to the buffer
  - serializeTo
```
public int serializeTo(com.neeve.io.IOElasticBuffer buffer,
                       int offset)
```
    Default implementation of MessageView.serializeTo(IOElasticBuffer, int)
    
    Specified by:
    
    serializeTo in interface MessageView
    
    Parameters:
    
    buffer - The buffer to serialize the message to
    
    offset - The offset into the buffer to serialize the message
    
    Returns:
    
    The number of bytes serialized to the buffer
  - serializeTo
```
public int serializeTo(PktPacket packet)
```
    Default implementation of MessageView.serializeTo(PktPacket)
    
    Specified by:
    
    serializeTo in interface MessageView
    
    Parameters:
    
    packet - The packet to serialize the message to
    
    Returns:
    
    The number of bytes serialized to the packet
  - serializeTo
```
public int serializeTo(long addr,
                       int offset)
```
    Default implementation of MessageView.serializeTo(long , int )
    
    Specified by:
    
    serializeTo in interface MessageView
    
    Parameters:
    
    addr - The address of the region to serialize the message to
    
    offset - The offset from the start of the region to serialize the message to
    
    Returns:
    
    The number of bytes serialized to the region
  - deserializeFrom
```
public MessageView deserializeFrom(byte[] array,
                                   int offset,
                                   int len)
```
    Default implementation of MessageView.deserializeFrom(byte[], int, int)
    
    Specified by:
    
    deserializeFrom in interface MessageView
    
    Parameters:
    
    array - The array containing the serialized message
    
    offset - The offset into the array where the serialized message starts
    
    len - The length of the serialized message
    
    Returns:
    
    This message view for invocation chaining
  - deserializeFrom
```
public MessageView deserializeFrom(ByteBuffer buffer)
```
    Default implementation of MessageView.deserializeFrom(ByteBuffer)
    
    Specified by:
    
    deserializeFrom in interface MessageView
    
    Parameters:
    
    buffer - The buffer containing the serialized message
    
    Returns:
    
    This message view for invocation chaining
  - deserializeFrom
```
public MessageView deserializeFrom(com.neeve.io.IOBuffer buffer,
                                   int offset,
                                   int len)
```
    Default implementation of MessageView.deserializeFrom(IOBuffer, int, int)
    
    Specified by:
    
    deserializeFrom in interface MessageView
    
    Parameters:
    
    buffer - The buffer containing the serialized message
    
    offset - The offset into the buffer where the serialized message starts
    
    len - The length of the serialized message
    
    Returns:
    
    This message view for invocation chaining
  - deserializeFrom
```
public MessageView deserializeFrom(com.neeve.io.IOElasticBuffer buffer,
                                   int offset,
                                   int len)
```
    Default implementation of MessageView.deserializeFrom(IOElasticBuffer, int, int)
    
    Specified by:
    
    deserializeFrom in interface MessageView
    
    Parameters:
    
    buffer - The buffer containing the serialized message
    
    offset - The offset into the buffer where the serialized message starts
    
    len - The length of the serialized message
    
    Returns:
    
    This message view for invocation chaining
  - deserializeFrom
```
public MessageView deserializeFrom(PktPacket packet)
```
    Default implementation of MessageView.deserializeFrom(PktPacket)
    
    Specified by:
    
    deserializeFrom in interface MessageView
    
    Parameters:
    
    packet - The packet containing the serialized message
    
    Returns:
    
    This message view for invocation chaining
  - deserializeFrom
```
public MessageView deserializeFrom(long addr,
                                   int offset,
                                   int len)
```
    Default implementation of MessageView.deserializeFrom(long, int, int)
    
    Specified by:
    
    deserializeFrom in interface MessageView
    
    Parameters:
    
    addr - The address of the region to deserialize the message from
    
    offset - The offset from the start of the region to deserialize the message from
    
    len - The length of the serialized message
    
    Returns:
    
    This message view for invocation chaining
  - acquire
```
public final void acquire()
```
    Implementation of MessageView.acquire()
    
    Specified by:
    
    acquire in interface MessageView
  - getOwnershipCount
```
public final int getOwnershipCount()
```
    Implementation of MessageView.getOwnershipCount()
    
    Specified by:
    
    getOwnershipCount in interface MessageView
  - dispose
```
public int dispose()
```
    Default implementation of MessageView.dispose()
    This is the default implementation of the dispose method. The implementation just decrements the ownership count. Implementations that implement view object pooling or other such functionality should override this method but invoke this method to decrement the object reference count.
    
    Specified by:
    
    dispose in interface MessageView
  - saveMemory
```
public void saveMemory()
```
    Default implementation of MessageView.saveMemory()
    
    Specified by:
    
    saveMemory in interface MessageView
  - referenceTracker
```
public final UtlReferenceTracker referenceTracker()
```
    Implementation of UtlReferenceTracker.HasReferenceTracker.referenceTracker()
    
    Specified by:
    
    referenceTracker in interface UtlReferenceTracker.HasReferenceTracker
  - toString
```
public String toString()
```
    Return a string representation of this object
    
    Overrides:
    
    toString in class Object

Class MessageViewImpl

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

Fields inherited from interface com.neeve.sma.MessageView

Method Summary

Methods inherited from class com.neeve.util.UtlListElement

Methods inherited from class java.lang.Object

Methods inherited from interface com.neeve.sma.MessageView

Method Detail

setTag

getTag

getVfid

getType

getMessageEncodingType

getMessageTransportHeaders

setMessageTransportHeaders

getMessage

serializeTo

serializeTo

serializeToIOBuffer

serializeTo

serializeTo

serializeTo

serializeTo

deserializeFrom

deserializeFrom

deserializeFrom

deserializeFrom

deserializeFrom

deserializeFrom

acquire

getOwnershipCount

dispose

saveMemory

referenceTracker

toString