All communication with AMPS occurs through passing Messages. The AMPS clients provide named convenience methods for core AMPS functionality. These named methods work by creating and sending Messages to AMPS. More...

Inheritance diagram for AMPS.Client.Message:

Classes
class	Options
	Represents the possible values for message options in an AMPS command. Options in a message are combined in to a comma-delimited list. Each of these option values is comma-terminated, so they can be easily combined by simple string concatenation. More...

Public Types
enum class	Commands : int { Unknown = 0 , Publish = 1 , Subscribe = 2 , Unsubscribe = 4 , SOW = 8 , Heartbeat = 16 , SOWDelete = 32 , DeltaPublish = 64 , Logon = 128 , SOWAndSubscribe = 256 , DeltaSubscribe = 512 , SOWAndDeltaSubscribe = 1024 , StartTimer = 2048 , StopTimer = 4096 , GroupBegin = 8192 , GroupEnd = 16384 , OOF = 32768 , Ack = 65536 , Flush = 131072 , NoDataCommands }
	Tells AMPS how to interpret a message. Without a command, AMPS will reject the message. The relevancy or meaning of other Message fields like options will depend upon the value of its command field. More...

enum class	AckTypes : int { None = 0 , Received = 1 , Parsed = 2 , Processed = 4 , Persisted = 8 , Completed = 16 , Stats = 32 }
	Enum of maskable ints that represent the available types of Message acknowledgement. AMPS.Client.Command::getAckType() AMPS.Client.Command::setAckType(int) AMPS.Client.Command::addAckType(int) More...

enum class	State : int { None , Success , Failure , Retry }
	Enum of ints that represent the possible values for Message status. More...

enum class	Reasons : int { None = 0 , Duplicate = 1 , BadFilter = 2 , BadRegexTopic = 3 , SubscriptionAlreadyExists = 4 , Deleted = 5 , Expired = 6 , Match = 7 , InvalidTopic = 8 , NameInUse = 9 , AuthFailure = 10 , NotEntitled = 11 , AuthDisabled = 12 , InvalidBookmark = 13 , InvalidOrderBy = 14 , SubidInUse = 15 , NoTopic = 16 , LogonFailed = 17 , LogonRequired = 18 , InvalidTopicOrFilter = 19 , InvalidSubId = 20 , NoTopicOrFilter = 21 , NoClientName = 22 , BadSowKey = 23 , RegexTopicNotSupported = 24 , SowStoreFailed = 25 , ParseError = 26 , NotSupported = 27 , TxStoreFailure = 28 , DuplicateLogon = 29 , TxnReplayFailed = 30 , SowCanceled = 31 , InvalidOptions = 32 , InvalidMessageType = 33 , OrderByTooLarge = 34 , RejectedByTransportFilter = 35 , SowDeleteInvalid = 36 , PublishFilterNoMatch = 37 , Other = 38 }
	Enum of ints that represent the possible values for a Message reason. AMPS.Client.Message::setReason(int) AMPS.Client.Message::getReason() More...

enum class	SerializationResult { OK , BufferTooSmall }

Public Member Functions

Message (Encoding encoder, Encoding decoder)

void setBookmarkSeqNo (long val)

Sets the bookmark sequence number for this message. The BookmarkSeqNo is used by bookmark stores to track messages. More...

long getBookmarkSeqNo ()

Returns the bookmark sequence number for this message. The BookmarkSeqNo is used by bookmark stores to track messages. More...

abstract SerializationResult serialize (System.IO.MemoryStream buffer)

Message reset ()

Resets all of the Field members to null. More...

Message.AckTypes getAckType ()

Returns the type of acknowledgement for an acknowledgement Message. More...

Message.AckTypes getAckTypeOutgoing ()

Returns the type of acknowledgement for an outgoing Message. More...

Message setAckType (Message.AckTypes v)

Sets the type of acknowledgement for an acknowledgement message. More...

bool isAckTypeNull ()

Checks whether the AckType field is null. More...

int getBatchSize ()

Returns the batch size of this message. More...

Message setBatchSize (int v)

Sets the batch size for this message. More...

bool isBatchSizeNull ()

Checks to see if the batch size is null. More...

String getBookmark ()

Returns the AMPS bookmark for this message. The bookmark is an identifier assigned to AMPS to locate a Message in the transaction log. More...

BookmarkField getBookmarkRaw ()

Gets the raw value for the AMPS bookmark. The bookmark is an identifier assigned to AMPS to locate a Message in the transaction log. More...

Message setBookmark (String v)

Sets the value of the AMPS bookmark. The bookmark is an identifier assigned by AMPS to locate a message in the transaction log. Setting the bookmark is used for commands that locate messages in the log, such as bookmark subscribe or historical SOW query. Setting the bookmark on a publish message has no effect. More...

Message setBookmark (byte[] buffer, int offset, int length)

Sets the value of the AMPS bookmark. The bookmark is an identifier assigned by AMPS to locate a message in the transaction log. Setting the bookmark is used for commands that locate messages in the log, such as bookmark subscribe or historical SOW query. Setting the bookmark on a publish message has no effect. More...

bool isBookmarkNull ()

Checks to see if the bookmark field is null. More...

String getClientName ()

Gets the ClientName on this Message. More...

Field getClientNameRaw ()

Gets the ClientName on this Message. More...

Message setClientName (String v)

Sets the name of the Client sending the Message. More...

Message setClientName (byte[] buffer, int offset, int length)

Sets the name of the Client sending the Message. More...

bool isClientNameNull ()

Checks whether the ClientName field is null. More...

String getCommandId ()

Gets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. More...

Field getCommandIdRaw ()

Gets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. More...

bool getCommandId (CommandId v)

Gets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command. More...

Message setCommandId (String v)

Sets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages and Commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command. More...

Message setCommandId (CommandId v)

Sets the CommandId for this Message. CommandID is an identifier set by the client that is used to correlate later Messages and Commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command. More...

Message setCommandId (byte[] buffer, int offset, int length)

Sets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages and Commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command. More...

bool isCommandIdNull ()

Checks to see if the CommandId is null. More...

Commands getCommand ()

Returns the Command for this Message, indicating the type of message this is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command reference for details. More...

Message setCommand (Commands v)

Sets the Command for this Message, indicating the type of messagethis is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command reference for details. More...

bool isCommandNull ()

Checks to see if the Command is null. More...

virtual String getData ()

Returns the payload of the Message. More...

Field getDataRaw ()

Returns the payload of the Message. More...

Message setData (String v)

Sets the payload of the Message. More...

Message setData (byte[] buffer, int offset, int length)

Sets the payload of the Message. More...

bool isDataNull ()

Checks to see if the data field is null. More...

IntegerField getExpirationRaw ()

Returns the Expiration field set for this Message. More...

int getExpiration ()

Returns the Expiration field for this Message. More...

Message setExpiration (int v)

Sets the Expiration for a Message. More...

bool isExpirationNull ()

Checked whether the Expiration is field is null. More...

String getFilter ()

Returns the Filter field for this Message. More...

Field getFilterRaw ()

Returns the Filter field on this Message.
More...

Message setFilter (String v)

Sets the Filter field on this Message. More...

Message setFilter (byte[] buffer, int offset, int length)

Sets the Filter field on this Message. More...

bool isFilterNull ()

Checks to see if the Filter is null on this Message. More...

String getOrderBy ()

Get the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results. More...

Field getOrderByRaw ()

Gets the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results. More...

Message setOrderBy (String v)

Set the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results. See the AMPS User Guide for details. More...

Message setOrderBy (byte[] buffer, int offset, int length)

Set the OrderBy parameter for this Message. For commands that support ordering, this parameter provies the order in which AMPS returns results. See the AMPS User Guide for details. More...

bool isOrderByNull ()

Checks to see if the OrderBy parameter is null. More...

long getGroupSeqNo ()

Get the GroupSeqNo. The group sequence number is the number of the batch within the SOW response, and is set on incoming messages by the AMPS client. More...

Message setGroupSeqNo (long v)

Set the GroupSeqNo. The group sequence number is the number of the batch within the SOW response, and is set on incoming messages by the AMPS client. More...

bool isGroupSeqNoNull ()

Checks whether the GroupSeqNo field is null. More...

long getMatches ()

Returns the number of matches in the command this Message acknowledges. This header is provided on an acknowledgement message that includes information on the number of matches. See the AMPS Command Reference for details. More...

Message setMatches (long v)

Sets the matches field on this Message. This header is typically provided by AMPS. More...

bool isMatchesNull ()

Checks whether the Matches field is null. More...

String getMessageType ()

Returns the MessageType on this client. MessageType is used to specify the message type given in the URI. More...

Message setMessageType (String v)

Sets the MessageType on this client. MessageType is used to specify the message type given in the URI. More...

bool isMessageTypeNull ()

Checks whether the MessageType field is null. More...

string getPassword ()

Returns the Password set on this Message. This field is typically used during the logon sequence. More...

Field getPasswordRaw ()

Returns the Password set on this Message. This field is typically used during the logon sequence. More...

Message setPassword (byte[] data, int offset, int length)

Set the Password on the Message. This field is typically used during the logon sequence. More...

Message setPassword (string password)

Set the password on the Message. This field is typically used during the logon sequence. More...

int getLength ()

Returns the Length of the Message. More...

Message setLength (int v)

Sets the Length of the Message. This field is typically set by the AMPS Client API rather than by application code. More...

bool isPasswordNull ()

Checks whether the Password field is null. More...

Field getOptionsRaw ()

Returns the Options to be seet on this Message. More...

string getOptions ()

Returns the Options to be set on this Message. More...

Message setOptions (string options)

Sets the Options for this Message. Options are a comma-delimited list of parameters. The values accepted for options depend on the command: see the AMPS Command Reference for details. More...

bool isOptionsNull ()

Checks to see if the Options field is null. More...

String getQueryId ()

Returns the QueryId for this Message. More...

Field getQueryIdRaw ()

Returns the QueryId for this Message. More...

bool isQueryIdNull ()

Checks whether the QueryId field is null. More...

bool getQueryId (CommandId v)

Returns the QueryId for this Message by copying it into the provided CommandId. More...

Message setQueryId (String v)

Sets the QueryId field for this Message. Typically, the QueryId is set by the AMPS client on incoming messages. More...

Message setQueryId (CommandId v)

Sets the QueryId for this Message by copying it from a CommandId object. Typically, the QueryId is set for incoming messages by the AMPS Client. More...

Message setQueryId (byte[] buffer, int offset, int position)

Set the QueryId for this Message. Typically, the QueryId is set for incoming messages by the AMPS Client. More...

Reasons getReason ()

Returns the Reason value for this Message. The Reason is set on acknowledgement messages to provide more information about the acknowledgement. More...

string getReasonText ()

Returns the Reason value for this Message. Typically, the Reason is set for incoming messages by the AMPS Client. More...

Message setReason (Reasons v)

Set the Reason value for this Message. Typically, the Reason is set for incoming messages by the AMPS Client. More...

bool isReasonNull ()

Checks whether the Reason is null. More...

long getRecordsDeleted ()

Returns the number of records deleted for the command that this Message was produced in response to. This header is provided on an acknowledgement message. See the AMPS Command Reference for more details. More...

Message setRecordsDeleted (long v)

Sets the records deleted header field. This header is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details. More...

bool isRecordsDeletedNull ()

Checks whether the RecordsDeleted field is null. More...

long getRecordsInserted ()

Returns the number of records inserted for the command that this Message was produced for. This header is provided on an acknowledgement message that includes information on the number of records inserted. See the AMPS Command Reference for details. More...

Message setRecordsInserted (long v)

Sets the Records Inserted field. This header is provided on an acknowledgement message. An application typically does not need to set this field. See the AMPS Command Reference for details. More...

bool isRecordsInsertedNull ()

Checks whether the RecordsInserted field is null. More...

long getRecordsUpdated ()

Returns the number of records updated for the command that this Message was produced in response to. More...

Message setRecordsUpdated (long v)

Sets the RecordsUpdated header field. More...

bool isRecordsUpdatedNull ()

Checks whether the RecordsUpdated field is null. More...

long getRecordsReturned ()

Returns the number of records returned for the command that this Message was produced in response to. More...

Message setRecordsReturned (long v)

Sets the RecordsReturned header field. More...

bool isRecordsReturnedNull ()

Checks whether the RecordsReturned field is null. More...

Field getSequenceRaw ()

Returns the sequence number for this Message. More...

ulong getSequence ()

Returns the sequence number for this Message. More...

Message setSequence (ulong v)

Sets the sequence number for this Message. More...

bool isSequenceNull ()

Checks whether the Sequence field is null. More...

String getSowKey ()

Returns the SowKey for this Message. More...

Field getSowKeyRaw ()

Returns the SowKey for this Message. More...

Message setSowKey (String v)

Sets the SowKey for this Message. More...

Message setSowKey (byte[] buffer, int offset, int length)

Sets the SowKey for this Message. More...

bool isSowKeyNull ()

Checks whether the SowKey field is null. More...

String getSowKeys ()

Gets the set of SowKeys this message applies to. More...

Field getSowKeysRaw ()

Message setSowKeys (String v)

Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers. This can be useful for commands that operate on multiple SOW records, such as a sow_delete that specifies a set of keys to remove. More...

Message setSowKeys (byte[] buffer, int offset, int length)

Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers. This can be useful for commands that operate on multiple SOW records, such as a sow_delete that specifies a set of keys to remove. More...

bool isSowKeysNull ()

Checks whether the SowKeys field is null. More...

State getStatus ()

Returns the Status of this Message. More...

Message setStatus (State v)

Sets the Status of this Message. More...

bool isStatusNull ()

Checks to see whether the Status field is null. More...

String getSubId ()

Gets the SubId of this Message. More...

Field getSubIdRaw ()

Gets the SubId of this Message. More...

bool getSubId (CommandId v)

Gets the SubId of this Message by copying it into the provided CommandId. More...

Message setSubId (String v)

Sets the SubId of this Message. More...

Message setSubId (CommandId v)

Sets the SubId of this Message by copying it from a CommandId object. More...

Message setSubId (byte[] buffer, int offset, int length)

Sets the SubId of this Message. More...

bool isSubIdNull ()

Checks whether the SubId field is null. More...

String getSubIds ()

The set of SubIds for this Message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list. More...

Field getSubIdsRaw ()

The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list. More...

Message setSubIds (String v)

The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list. More...

Message setSubIds (byte[] buffer, int offset, int length)

The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message. More...

bool isSubIdsNull ()

Checks whether the SubIds field is null. More...

String getTimestamp ()

Returns the timestamp for this message, an ISO-8601 formatted string. The timestamp is set by AMPS at the time that AMPS processes the message. More...

Field getTimestampRaw ()

Returns the timestamp for this message, an ISO-8601 formatted string. The timestamp is set by AMPS at the time that AMPS processes the message. More...

Message setTimestamp (String v)

Sets the Timestamp for this Message. The timestamp is set by AMPS at the time that AMPS processes the message. There is generally no need to set this field in your application. More...

Message setTimestamp (byte[] buffer, int offset, int length)

Sets the timestamp for this message. The timestamp is set by AMPS at the time that AMPS processes the message. There is generally no need to set this field in your application. More...

bool isTimestampNull ()

Checks to see if the Timestamp field is null. More...

long getTopN ()

Get the TopN parameter for this message. For commands that support limiting the number of messages in the result set, this parameter provides the limit to AMPS. More...

Message setTopN (long v)

Set the TopN parameter for this message. For commands that support limiting the number of messages in the result set, this parameter provides the limit to AMPS. More...

bool isTopNNull ()

Checks to see whether the TopN parameter for this message is null. For commands that support limiting the number of messgaes in the result set, this parameter provides the limit to AMPS. More...

String getTopic ()

Return the topic that the message applies to. More...

Field getTopicRaw ()

Return the topic that the message applies to. More...

Message setTopic (String v)

Set the topic that the message applies to. More...

Message setTopic (byte[] buffer, int offset, int length)

Set the topic that the message applies to. More...

bool isTopicNull ()

Checks whether the Topic field is null. More...

long getTopicMatches ()

Returns the number of matching topics for the command that this message was produced in response to. More...

Message setTopicMatches (long v)

Sets the topic matches field on this message. This header is typically provided by AMPS. More...

bool isTopicMatchesNull ()

Checks to see if the topic matches field on this message is null. More...

String getUserId ()

Get the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. More...

Field getUserIdRaw ()

Get the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. More...

Message setUserId (String v)

Set the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. Therefore, applications generally only set this value during logon. More...

Message setUserId (byte[] buffer, int offset, int length)

Set the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. Therefore, applications generally only set this value during logon.

Parameters

buffer	the buffer that contains the UserId
offset	the position where the UserId begins
length	the length of the UserId

Returns: Returns this instance so that various operations can be chained together.

bool isUserIdNull ()

Checks to see if the UserId field is null. More...

String getVersion ()

Returns the version of the AMPS server, provided in response to a logon. More...

Field getVersionRaw ()

Returns the version of the AMPS server, provided in response to a logon. More...

int getVersionAsInt ()

Returns the version of the AMPS server, provided in response to a logon. More...

Message setVersion (String v)

Sets the version field of this message. This is typically done by the AMPS client API when a message with this field set is received. More...

Message setVersion (byte[] buffer, int offset, int length)

Sets the version field of this message. This is typically done by the AMPS client API when a message with this field set is received. More...

bool isVersionNull ()

Checks to see if the Version field is null. More...

String getCorrelationId ()

Get the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier. More...

Message setCorrelationId (String correlationId_)

Set the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier. More...

StringField getCorrelationIdRaw ()

Get the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier. More...

bool isCorrelationIdNull ()

Checks to see if the CorrelationId field is null. More...

bool isLeasePeriodNull ()

Returns true if the LeasePeriod field is null More...

String getLeasePeriod ()

Returns the value of the LeasePeriod field More...

StringField getLeasePeriodRaw ()

Returns the raw value of the LeasePeriod field More...

override string ToString ()

abstract Message copy ()

void setBuffer (byte[] buffer)

byte[] getBuffer ()

void setRawBufferOffset (int offset)

int getRawBufferOffset ()

void setRawBufferLength (int length)

int getRawBufferLength ()

Client getClient ()

Returns the Client who allocated this message. More...

void ack (String options=null)

Acks the message to the server if it was a Queue message. More...

void ack (Field options)

Acks the message to the server if it was a Queue message. More...

bool isIgnoreAutoAck ()

void setIgnoreAutoAck ()

Public Attributes
Encoding	encoder = null

Encoding	decoder = null

StringField	_Version = new StringField()

Static Protected Attributes
const int	MINIMUM_SERVER_VERSION = Client.DEFAULT_SERVER_VERSION

Properties
String	LeasePeriod `[get]`
	Returns the value of the LeasePeriod field More...

Client	Client `[get]`
	The Client who allocated this message. More...

Int64	GroupSeqNo `[get, set]`

Int64	Matches `[get, set]`

Int32	Length `[get, set]`

String	QueryId `[get, set]`

Reasons	Reason `[get, set]`

Int64	RecordsInserted `[get, set]`

Int64	RecordsUpdated `[get, set]`

Int64	RecordsDeleted `[get, set]`

Int64	RecordsReturned `[get, set]`

UInt64	Sequence `[get, set]`

String	SowKey `[get, set]`

String	SowKeys `[get, set]`

State	Status `[get, set]`

String	SubId `[get, set]`

String	SubIds `[get, set]`

String	Timestamp `[get, set]`

Int64	TopN `[get, set]`

String	Topic `[get, set]`

Int64	TopicMatches `[get, set]`

String	UserId `[get, set]`

String	Password `[get, set]`

String	Data `[get, set]`

AckTypes	AckType `[get, set]`

Int32	BatchSize `[get, set]`

String	Bookmark `[get, set]`

String	ClientName `[get, set]`

String	CommandId `[get, set]`

Commands	Command `[get, set]`

Int32	Expiration `[get, set]`

String	Filter `[get, set]`

String	OrderBy `[get, set]`

String	CorrelationId `[get, set]`

Detailed Description

All communication with AMPS occurs through passing Messages. The AMPS clients provide named convenience methods for core AMPS functionality. These named methods work by creating and sending Messages to AMPS.

Member Enumeration Documentation

◆ AckTypes

enum AMPS.Client.Message.AckTypes : int

strong

Enum of maskable ints that represent the available types of Message acknowledgement. AMPS.Client.Command::getAckType() AMPS.Client.Command::setAckType(int) AMPS.Client.Command::addAckType(int)

◆ Commands

enum AMPS.Client.Message.Commands : int

strong

Tells AMPS how to interpret a message. Without a command, AMPS will reject the message. The relevancy or meaning of other Message fields like options will depend upon the value of its command field.

◆ Reasons

enum AMPS.Client.Message.Reasons : int

strong

Enum of ints that represent the possible values for a Message reason. AMPS.Client.Message::setReason(int) AMPS.Client.Message::getReason()

◆ State

enum AMPS.Client.Message.State : int

strong

Enum of ints that represent the possible values for Message status.

Member Function Documentation

◆ ack() [1/2]

void AMPS.Client.Message.ack ( Field options )

inline

Acks the message to the server if it was a Queue message.

Parameters

options The optional options to use for the ack, such as "cancel".

◆ ack() [2/2]

void AMPS.Client.Message.ack ( String options = null )

inline

Acks the message to the server if it was a Queue message.

Parameters

options The optional options to use for the ack, such as "cancel".

◆ getAckType()

Message.AckTypes AMPS.Client.Message.getAckType ( )

inline

Returns the type of acknowledgement for an acknowledgement Message.

Returns: The AckType for this acknowledgement message.

◆ getAckTypeOutgoing()

Message.AckTypes AMPS.Client.Message.getAckTypeOutgoing ( )

inline

Returns the type of acknowledgement for an outgoing Message.

Returns: The AckType for an outgoing acknowledgement message.

◆ getBatchSize()

int AMPS.Client.Message.getBatchSize ( )

inline

Returns the batch size of this message.

Returns: The batch size of this message.

◆ getBookmark()

String AMPS.Client.Message.getBookmark ( )

inline

Returns the AMPS bookmark for this message. The bookmark is an identifier assigned to AMPS to locate a Message in the transaction log.

Returns: The AMPS bookmark for this message.

◆ getBookmarkRaw()

BookmarkField AMPS.Client.Message.getBookmarkRaw ( )

inline

Gets the raw value for the AMPS bookmark. The bookmark is an identifier assigned to AMPS to locate a Message in the transaction log.

The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. It does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw value for the AMPS bookmark.

◆ getBookmarkSeqNo()

long AMPS.Client.Message.getBookmarkSeqNo ( )

inline

Returns the bookmark sequence number for this message. The BookmarkSeqNo is used by bookmark stores to track messages.

Returns: The bookmark sequence number for this message.

◆ getBuffer()

byte [] AMPS.Client.Message.getBuffer ( )

inline

Gets the byte buffer used by the message.

Returns: the raw byte buffer backing this message object.

◆ getClient()

Client AMPS.Client.Message.getClient ( )

inline

Returns the Client who allocated this message.

Returns: The Client.

◆ getClientName()

String AMPS.Client.Message.getClientName ( )

inline

Gets the ClientName on this Message.

Returns: The client name of the message.

◆ getClientNameRaw()

Field AMPS.Client.Message.getClientNameRaw ( )

inline

Gets the ClientName on this Message.

The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw ClientName on this Message.

◆ getCommand()

Commands AMPS.Client.Message.getCommand ( )

inline

Returns the Command for this Message, indicating the type of message this is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command reference for details.

Returns: The Command for this Message.

◆ getCommandId() [1/2]

String AMPS.Client.Message.getCommandId ( )

inline

Gets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe.

Returns: The decoded CommandId for this Message.

◆ getCommandId() [2/2]

bool AMPS.Client.Message.getCommandId ( CommandId v )

inline

Gets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.

Parameters

v	The object to hold the value of the CommandId object.

Returns: A copy of the Message in the provided CommandId object.

◆ getCommandIdRaw()

Field AMPS.Client.Message.getCommandIdRaw ( )

inline

Gets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe.

The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw CommandId on this Message.

◆ getCorrelationId()

String AMPS.Client.Message.getCorrelationId ( )

inline

Get the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier.

Returns: The decoded version of the CorrelationId on this Message.

◆ getCorrelationIdRaw()

StringField AMPS.Client.Message.getCorrelationIdRaw ( )

inline

Get the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier.

The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw CorrelationId on this Message.

◆ getData()

virtual String AMPS.Client.Message.getData ( )

inlinevirtual

Returns the payload of the Message.

Returns: The payload of the Message.

◆ getDataRaw()

Field AMPS.Client.Message.getDataRaw ( )

inline

Returns the payload of the Message.

The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer of the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw payload of this Message.

◆ getExpiration()

int AMPS.Client.Message.getExpiration ( )

inline

Returns the Expiration field for this Message.

The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulatees the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Messgae, then you must copy the Field.

Returns: The raw Expiration for this Message.

◆ getExpirationRaw()

IntegerField AMPS.Client.Message.getExpirationRaw ( )

inline

Returns the Expiration field set for this Message.

Returns: The Expiration for this Message.

◆ getFilter()

String AMPS.Client.Message.getFilter ( )

inline

Returns the Filter field for this Message.

Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.

Returns: The decoded Filter on this Message.

◆ getFilterRaw()

Field AMPS.Client.Message.getFilterRaw ( )

inline

Returns the Filter field on this Message.

Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete. The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw Filter on this Message.

◆ getGroupSeqNo()

long AMPS.Client.Message.getGroupSeqNo ( )

inline

Get the GroupSeqNo. The group sequence number is the number of the batch within the SOW response, and is set on incoming messages by the AMPS client.

Returns: The GroupSeqNo for this Message.

◆ getLeasePeriod()

String AMPS.Client.Message.getLeasePeriod ( )

inline

Returns the value of the LeasePeriod field

◆ getLeasePeriodRaw()

StringField AMPS.Client.Message.getLeasePeriodRaw ( )

inline

Returns the raw value of the LeasePeriod field

Returns: A StringField pointing to the raw message's LeasePeriod.

◆ getLength()

int AMPS.Client.Message.getLength ( )

inline

Returns the Length of the Message.

Returns: The Length of the message.

◆ getMatches()

long AMPS.Client.Message.getMatches ( )

inline

Returns the number of matches in the command this Message acknowledges. This header is provided on an acknowledgement message that includes information on the number of matches. See the AMPS Command Reference for details.

Returns: The number of matches in the command that this Message acknowledges.

◆ getMessageType()

String AMPS.Client.Message.getMessageType ( )

inline

Returns the MessageType on this client. MessageType is used to specify the message type given in the URI.

Returns: The MessageType on this client.

◆ getOptions()

string AMPS.Client.Message.getOptions ( )

inline

Returns the Options to be set on this Message.

Returns: The options to be set on this Message.

◆ getOptionsRaw()

Field AMPS.Client.Message.getOptionsRaw ( )

inline

Returns the Options to be seet on this Message.

The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw Options for this Message.

◆ getOrderBy()

String AMPS.Client.Message.getOrderBy ( )

inline

Get the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results.

Returns: The decoded OrderBy parameter for this Message.

◆ getOrderByRaw()

Field AMPS.Client.Message.getOrderByRaw ( )

inline

Gets the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results.

The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw OrderBy parameter for this Message.

◆ getPassword()

string AMPS.Client.Message.getPassword ( )

inline

Returns the Password set on this Message. This field is typically used during the logon sequence.

Returns: The decoded Password set on the specified Message.

◆ getPasswordRaw()

Field AMPS.Client.Message.getPasswordRaw ( )

inline

Returns the Password set on this Message. This field is typically used during the logon sequence.

The RAW variation of this geetter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw Password set on this Message.

◆ getQueryId() [1/2]

String AMPS.Client.Message.getQueryId ( )

inline

Returns the QueryId for this Message.

The QueryId returned on a message is the CommandId of the command that ran the query. For example, when sending a SOW command to AMPS, messages returned in response to that command will have the QueryId set to the CommandId of the SOW command.

Returns: The decoded QueryId for this Message.

◆ getQueryId() [2/2]

bool AMPS.Client.Message.getQueryId ( CommandId v )

inline

Returns the QueryId for this Message by copying it into the provided CommandId.

The QueryId returned on a message is the CommandId of the command that ran the query. For example, when sending a SOW command to AMPS, messages returned in response to that command will have the QueryId set to the CommandId of the SOW command.

Parameters

v	The CommandId to be used to copy the QueryId.

◆ getQueryIdRaw()

Field AMPS.Client.Message.getQueryIdRaw ( )

inline

Returns the QueryId for this Message.

The QueryId returned on a message is the CommandId of the command that ran the query. For example, when sending a SOW command to AMPS, messages returned in response to that command will have the QueryId set to the CommandId of the SOW command. The RAW variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw QueryId for this Message.

◆ getRawBufferLength()

int AMPS.Client.Message.getRawBufferLength ( )

inline

Gets the length of the message within the byte buffer.

Returns: length of message within the buffer.

◆ getRawBufferOffset()

int AMPS.Client.Message.getRawBufferOffset ( )

inline

Gets the offset into the byte buffer where this message begins.

Returns: offset of first byte of message within the buffer.

◆ getReason()

Reasons AMPS.Client.Message.getReason ( )

inline

Returns the Reason value for this Message. The Reason is set on acknowledgement messages to provide more information about the acknowledgement.

Returns: The value in the Reason field of this Message.

◆ getReasonText()

string AMPS.Client.Message.getReasonText ( )

inline

Returns the Reason value for this Message. Typically, the Reason is set for incoming messages by the AMPS Client.

Returns: The value in the Reason field of this Message.

◆ getRecordsDeleted()

long AMPS.Client.Message.getRecordsDeleted ( )

inline

Returns the number of records deleted for the command that this Message was produced in response to. This header is provided on an acknowledgement message. See the AMPS Command Reference for more details.

Returns: The number of records deleted for the command that this Message was produced for.

◆ getRecordsInserted()

long AMPS.Client.Message.getRecordsInserted ( )

inline

Returns the number of records inserted for the command that this Message was produced for. This header is provided on an acknowledgement message that includes information on the number of records inserted. See the AMPS Command Reference for details.

Returns: The number of records inserted for the command that produced this Message.

◆ getRecordsReturned()

long AMPS.Client.Message.getRecordsReturned ( )

inline

Returns the number of records returned for the command that this Message was produced in response to.

This header is provided on an acknowledgement message. See the AMPS Command Reference for details.

Returns: The number of RecordsReturned for the command that this Message was produced for.

◆ getRecordsUpdated()

long AMPS.Client.Message.getRecordsUpdated ( )

inline

Returns the number of records updated for the command that this Message was produced in response to.

This header is provided on an acknowledgement message. See the AMPS Command Reference for details.

Returns: The number of records updated for the command that this Message was produced for.

◆ getSequence()

ulong AMPS.Client.Message.getSequence ( )

inline

Returns the sequence number for this Message.

On outgoing messages, this field is typically set by the AMPS client. The sequence number is used by AMPS for duplicate detection. Each combination of client name and sequence number should be a unique message. In response to a logon, AMPS may return the last sequence number received from a client to assist in recovery.

Returns: The decoded sequence number for this Message, in the form of an unsigned long.

◆ getSequenceRaw()

Field AMPS.Client.Message.getSequenceRaw ( )

inline

Returns the sequence number for this Message.

On outgoing messages, this field is typically set by the AMPS client. The sequence number is used by AMPS for duplicate detection. Each combination of client name and sequence number should be a unique message. In response to a login, AMPS may return the last sequence number received from a client to assist in recovery. The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw sequence number for this Message.

◆ getSowKey()

String AMPS.Client.Message.getSowKey ( )

inline

Returns the SowKey for this Message.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SowKey on each message.

Returns: The decoded SowKey for this Message.

◆ getSowKeyRaw()

Field AMPS.Client.Message.getSowKeyRaw ( )

inline

Returns the SowKey for this Message.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS> For messages received from a SOW, AMPS provides the SowKey on each message. The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The Raw SowKey for this Message.

◆ getSowKeys()

String AMPS.Client.Message.getSowKeys ( )

inline

Gets the set of SowKeys this message applies to.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.

Returns: The decoded set of SowKeys this message applies to.

◆ getSowKeysRaw()

Field AMPS.Client.Message.getSowKeysRaw ( )

inline

Returns the set of SowKeys this message applies to.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS> For messages received from a SOW, AMPS provides the SowKey on each message. The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The Raw SowKeys this message applies to.

◆ getStatus()

State AMPS.Client.Message.getStatus ( )

inline

Returns the Status of this Message.

This field is provided by AMPS on acknowledgements to indicate the success or failure of the command being acknowledged.

Returns: The Status of this Message, which will be None, Success, Failure or Retry.

◆ getSubId() [1/2]

String AMPS.Client.Message.getSubId ( )

inline

Gets the SubId of this Message.

The SubId is a reference to the CommandId of the command that created the subscription.

Returns: The decoded SubId of this Message.

◆ getSubId() [2/2]

bool AMPS.Client.Message.getSubId ( CommandId v )

inline

Gets the SubId of this Message by copying it into the provided CommandId.

The SubId is a reference to the CommandId of the command that created the subscription.

Returns: The CommandId containing the SubId.

Parameters

v	The CommandId object to hold the SubId.

◆ getSubIdRaw()

Field AMPS.Client.Message.getSubIdRaw ( )

inline

Gets the SubId of this Message.

The SubId is a reference to the CommandId of the command that created the subscription. The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime ofthe Message, you must copy the Field.

Returns: The raw SubId of this Message.

◆ getSubIds()

String AMPS.Client.Message.getSubIds ( )

inline

The set of SubIds for this Message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list.

The SubId is the identifier provided when the subscription was registered with AMPS.

Returns: The decoded set of SubIds for this Message.

◆ getSubIdsRaw()

Field AMPS.Client.Message.getSubIdsRaw ( )

inline

The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list.

The SubId is the identifier provided when the subscription was registered with AMPS. The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw set of SubIds for this message.

◆ getTimestamp()

String AMPS.Client.Message.getTimestamp ( )

inline

Returns the timestamp for this message, an ISO-8601 formatted string. The timestamp is set by AMPS at the time that AMPS processes the message.

Returns: The Timestamp for this Message as an ISO-8601 formatted string.

◆ getTimestampRaw()

Field AMPS.Client.Message.getTimestampRaw ( )

inline

Returns the timestamp for this message, an ISO-8601 formatted string. The timestamp is set by AMPS at the time that AMPS processes the message.

The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw Timestamp for this Message.

◆ getTopic()

String AMPS.Client.Message.getTopic ( )

inline

Return the topic that the message applies to.

Returns: The decoded Topic that the Message applies to.

◆ getTopicMatches()

long AMPS.Client.Message.getTopicMatches ( )

inline

Returns the number of matching topics for the command that this message was produced in response to.

This header is provided on an acknowledgement message that includes information on the number of records inserted. See the AMPS Command Reference for details.

Returns: The number of matching topics for the command that this Message was produced in response to.

◆ getTopicRaw()

Field AMPS.Client.Message.getTopicRaw ( )

inline

Return the topic that the message applies to.

The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw Topic that the Message applies to.

◆ getTopN()

long AMPS.Client.Message.getTopN ( )

inline

Get the TopN parameter for this message. For commands that support limiting the number of messages in the result set, this parameter provides the limit to AMPS.

Returns: The TopN parameter for this Message.

◆ getUserId()

String AMPS.Client.Message.getUserId ( )

inline

Get the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published.

Returns: The decoded UserId for this message.

◆ getUserIdRaw()

Field AMPS.Client.Message.getUserIdRaw ( )

inline

Get the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published.

The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw UserId for this Message.

◆ getVersion()

String AMPS.Client.Message.getVersion ( )

inline

Returns the version of the AMPS server, provided in response to a logon.

Returns: The decoded version of the AMPS server.

◆ getVersionAsInt()

int AMPS.Client.Message.getVersionAsInt ( )

inline

Returns the version of the AMPS server, provided in response to a logon.

Returns: The version of AMPS server.

◆ getVersionRaw()

Field AMPS.Client.Message.getVersionRaw ( )

inline

Returns the version of the AMPS server, provided in response to a logon.

The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data. This does not incur any additional allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.

Returns: The raw version of the AMPS server.

◆ isAckTypeNull()

bool AMPS.Client.Message.isAckTypeNull ( )

inline

Checks whether the AckType field is null.

Returns: true if AckType field is null, false if not.

◆ isBatchSizeNull()

bool AMPS.Client.Message.isBatchSizeNull ( )

inline

Checks to see if the batch size is null.

Returns: true if batch size is null, false if not.

◆ isBookmarkNull()

bool AMPS.Client.Message.isBookmarkNull ( )

inline

Checks to see if the bookmark field is null.

Returns: true if the bookmark field is null, false if not.

◆ isClientNameNull()

bool AMPS.Client.Message.isClientNameNull ( )

inline

Checks whether the ClientName field is null.

Returns: true if the ClientName field is null, false if not.

◆ isCommandIdNull()

bool AMPS.Client.Message.isCommandIdNull ( )

inline

Checks to see if the CommandId is null.

Returns: true if the CommandId is null, false if not.

◆ isCommandNull()

bool AMPS.Client.Message.isCommandNull ( )

inline

Checks to see if the Command is null.

Returns: true if the Command is null, false if not.

◆ isCorrelationIdNull()

bool AMPS.Client.Message.isCorrelationIdNull ( )

inline

Checks to see if the CorrelationId field is null.

Returns: true if null, false if not.

◆ isDataNull()

bool AMPS.Client.Message.isDataNull ( )

inline

Checks to see if the data field is null.

Returns: true if the data field is null, false if not.

◆ isExpirationNull()

bool AMPS.Client.Message.isExpirationNull ( )

inline

Checked whether the Expiration is field is null.

Returns: true if the Expiration field is null, false if not.

◆ isFilterNull()

bool AMPS.Client.Message.isFilterNull ( )

inline

Checks to see if the Filter is null on this Message.

Returns: true if the Filter is null, false if not.

◆ isGroupSeqNoNull()

bool AMPS.Client.Message.isGroupSeqNoNull ( )

inline

Checks whether the GroupSeqNo field is null.

Returns: true if the GroupSeqNo field is null, false if not.

◆ isLeasePeriodNull()

bool AMPS.Client.Message.isLeasePeriodNull ( )

inline

Returns true if the LeasePeriod field is null

◆ isMatchesNull()

bool AMPS.Client.Message.isMatchesNull ( )

inline

Checks whether the Matches field is null.

Returns: true if the Matches field is null, false if not.

◆ isMessageTypeNull()

bool AMPS.Client.Message.isMessageTypeNull ( )

inline

Checks whether the MessageType field is null.

Returns: true if MessageType field is null, false if not.

◆ isOptionsNull()

bool AMPS.Client.Message.isOptionsNull ( )

inline

Checks to see if the Options field is null.

Returns: true if null, false if not.

◆ isOrderByNull()

bool AMPS.Client.Message.isOrderByNull ( )

inline

Checks to see if the OrderBy parameter is null.

Returns: true if the OrderBy parameter is null, false if not.

◆ isPasswordNull()

bool AMPS.Client.Message.isPasswordNull ( )

inline

Checks whether the Password field is null.

Returns: true if the Password field is null, false if not.

◆ isQueryIdNull()

bool AMPS.Client.Message.isQueryIdNull ( )

inline

Checks whether the QueryId field is null.

Returns: true if the QueryId field is null, false if not.

◆ isReasonNull()

bool AMPS.Client.Message.isReasonNull ( )

inline

Checks whether the Reason is null.

Returns: true if the Reason field is null, false if not.

◆ isRecordsDeletedNull()

bool AMPS.Client.Message.isRecordsDeletedNull ( )

inline

Checks whether the RecordsDeleted field is null.

Returns: true if the RecordsDeleted field is null, false if not.

◆ isRecordsInsertedNull()

bool AMPS.Client.Message.isRecordsInsertedNull ( )

inline

Checks whether the RecordsInserted field is null.

Returns: true if the RecordsInserted field is null, false if not.

◆ isRecordsReturnedNull()

bool AMPS.Client.Message.isRecordsReturnedNull ( )

inline

Checks whether the RecordsReturned field is null.

Returns: true if the RecordsReturned field is null, false if not.

◆ isRecordsUpdatedNull()

bool AMPS.Client.Message.isRecordsUpdatedNull ( )

inline

Checks whether the RecordsUpdated field is null.

Returns: true if the RecordsUpdated field is null, false if not.

◆ isSequenceNull()

bool AMPS.Client.Message.isSequenceNull ( )

inline

Checks whether the Sequence field is null.

Returns: true if the Sequence field is null, false if not.

◆ isSowKeyNull()

bool AMPS.Client.Message.isSowKeyNull ( )

inline

Checks whether the SowKey field is null.

Returns: true if the SowKey field is null, false if not.

◆ isSowKeysNull()

bool AMPS.Client.Message.isSowKeysNull ( )

inline

Checks whether the SowKeys field is null.

Returns: true if the SowKeys field is null, false if not.

◆ isStatusNull()

bool AMPS.Client.Message.isStatusNull ( )

inline

Checks to see whether the Status field is null.

Returns: true if the Status field is null, false if not.

◆ isSubIdNull()

bool AMPS.Client.Message.isSubIdNull ( )

inline

Checks whether the SubId field is null.

Returns: true if the SubId is null, false if not.

◆ isSubIdsNull()

bool AMPS.Client.Message.isSubIdsNull ( )

inline

Checks whether the SubIds field is null.

Returns: true if null, false if not.

◆ isTimestampNull()

bool AMPS.Client.Message.isTimestampNull ( )

inline

Checks to see if the Timestamp field is null.

Returns: true if the Timestamp field is null, false if not.

◆ isTopicMatchesNull()

bool AMPS.Client.Message.isTopicMatchesNull ( )

inline

Checks to see if the topic matches field on this message is null.

Returns: true if the topic matches field is null, false if not.

◆ isTopicNull()

bool AMPS.Client.Message.isTopicNull ( )

inline

Checks whether the Topic field is null.

Returns: true if the Topic field is null, false if not

◆ isTopNNull()

bool AMPS.Client.Message.isTopNNull ( )

inline

Checks to see whether the TopN parameter for this message is null. For commands that support limiting the number of messgaes in the result set, this parameter provides the limit to AMPS.

Returns: true if the TopN parameter is null, false if not.

◆ isUserIdNull()

bool AMPS.Client.Message.isUserIdNull ( )

inline

Checks to see if the UserId field is null.

Returns: true if UserId is null, false if not.

◆ isVersionNull()

bool AMPS.Client.Message.isVersionNull ( )

inline

Checks to see if the Version field is null.

Returns: true if the Version field is null, false if not.

◆ reset()

Message AMPS.Client.Message.reset ( )

inline

Resets all of the Field members to null.

Returns: The Message instance.

◆ setAckType()

Message AMPS.Client.Message.setAckType ( Message.AckTypes v )

inline

Sets the type of acknowledgement for an acknowledgement message.

Parameters

v	The value to set as the AckType for the acknowledgement message.

◆ setBatchSize()

Message AMPS.Client.Message.setBatchSize ( int v )

inline

Sets the batch size for this message.

Parameters

v	The batch size to set for the message.

◆ setBookmark() [1/2]

Message AMPS.Client.Message.setBookmark	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the value of the AMPS bookmark. The bookmark is an identifier assigned by AMPS to locate a message in the transaction log. Setting the bookmark is used for commands that locate messages in the log, such as bookmark subscribe or historical SOW query. Setting the bookmark on a publish message has no effect.

Parameters

buffer	The byte buffer containing the value for the bookmark.
offset	The location at which the value begins.
length	The length of the value in the buffer.

◆ setBookmark() [2/2]

Message AMPS.Client.Message.setBookmark ( String v )

inline

Sets the value of the AMPS bookmark. The bookmark is an identifier assigned by AMPS to locate a message in the transaction log. Setting the bookmark is used for commands that locate messages in the log, such as bookmark subscribe or historical SOW query. Setting the bookmark on a publish message has no effect.

Parameters

v	The string used to set the value of the AMPS bookmark.

◆ setBookmarkSeqNo()

void AMPS.Client.Message.setBookmarkSeqNo ( long val )

inline

Sets the bookmark sequence number for this message. The BookmarkSeqNo is used by bookmark stores to track messages.

Parameters

val	The value to set as the new BookmarkSeqNo for this message.

◆ setBuffer()

void AMPS.Client.Message.setBuffer ( byte[] buffer )

inline

Sets the byte buffer used by the message. It's not common for applications to use this directly.

Parameters

buffer the byte buffer to use for the message.

◆ setClientName() [1/2]

Message AMPS.Client.Message.setClientName	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the name of the Client sending the Message.

Parameters

buffer	The buffer containing the ClientName.
offset	The location at whcih ClientName begins in the buffer.
length	The length of the ClientName.

◆ setClientName() [2/2]

Message AMPS.Client.Message.setClientName ( String v )

inline

Sets the name of the Client sending the Message.

Parameters

v	The String used to set ClientName.

◆ setCommand()

Message AMPS.Client.Message.setCommand ( Commands v )

inline

Sets the Command for this Message, indicating the type of messagethis is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command reference for details.

Parameters

v	The Command object used to set the Command.

Returns: The Command that was set.

◆ setCommandId() [1/3]

Message AMPS.Client.Message.setCommandId	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages and Commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.

Parameters

buffer	The buffer containing the CommandId on this Message.
offset	The location at which the CommandId begins.
length	The length of the CommandId.

Returns: The CommandId

◆ setCommandId() [2/3]

Message AMPS.Client.Message.setCommandId ( CommandId v )

inline

Sets the CommandId for this Message. CommandID is an identifier set by the client that is used to correlate later Messages and Commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.

Parameters

v	The CommandId object to set on this Message.

Returns: The CommandId object.

◆ setCommandId() [3/3]

Message AMPS.Client.Message.setCommandId ( String v )

inline

Sets the CommandId for this Message. CommandId is an identifier set by the client that is used to correlate later Messages and Commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.

Parameters

v	The String CommandId to set on this Message.

◆ setCorrelationId()

Message AMPS.Client.Message.setCorrelationId ( String correlationId_ )

inline

Set the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier.

Parameters

v	The string used to set the CorrelationId on this message.

Returns: Returns this instance so that various operations can be chained together.

◆ setData() [1/2]

Message AMPS.Client.Message.setData	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the payload of the Message.

Parameters

buffer	The buffer containing the data.
offset	The location at which the data begins.
length	The length of the data.

◆ setData() [2/2]

Message AMPS.Client.Message.setData ( String v )

inline

Sets the payload of the Message.

Parameters

v	The string to set as the payload of this Message.

◆ setExpiration()

Message AMPS.Client.Message.setExpiration ( int v )

inline

Sets the Expiration for a Message.

The expiration is used on a publish command to set the lifetime of a message. For the lifetime to be processed by AMPS, the message must be published to a SOW topic that supports message expiration. See the AMPS user guide for details.

Parameters

v	The lifetime of the Message.

◆ setFilter() [1/2]

Message AMPS.Client.Message.setFilter	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the Filter field on this Message.

Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.

Parameters

buffer	The buffer containing the Filter for this Message.
offset	The location at which the Filter begins.
length	The length of the Filter.

◆ setFilter() [2/2]

Message AMPS.Client.Message.setFilter ( String v )

inline

Sets the Filter field on this Message.

Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.

Parameters

v	The string to set as the Filter on this Message.

◆ setGroupSeqNo()

Message AMPS.Client.Message.setGroupSeqNo ( long v )

inline

Set the GroupSeqNo. The group sequence number is the number of the batch within the SOW response, and is set on incoming messages by the AMPS client.

Parameters

v	The number to set as the GroupSeqNo.

◆ setLength()

Message AMPS.Client.Message.setLength ( int v )

inline

Sets the Length of the Message. This field is typically set by the AMPS Client API rather than by application code.

Parameters

v	The value to be set as the Length of the Message.

◆ setMatches()

Message AMPS.Client.Message.setMatches ( long v )

inline

Sets the matches field on this Message. This header is typically provided by AMPS.

Parameters

v	The number of matches in the command this Message acknowledges.

◆ setMessageType()

Message AMPS.Client.Message.setMessageType ( String v )

inline

Sets the MessageType on this client. MessageType is used to specify the message type given in the URI.

Returns: The MessageType of this client.

◆ setOptions()

Message AMPS.Client.Message.setOptions ( string options )

inline

Sets the Options for this Message. Options are a comma-delimited list of parameters. The values accepted for options depend on the command: see the AMPS Command Reference for details.

Parameters

options The string to be used as the Options for this Message.

◆ setOrderBy() [1/2]

Message AMPS.Client.Message.setOrderBy	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Set the OrderBy parameter for this Message. For commands that support ordering, this parameter provies the order in which AMPS returns results. See the AMPS User Guide for details.

Parameters

buffer	The buffer that contains the expression.
offset	The location at which the expression begins.
length	The length of the expresson.

◆ setOrderBy() [2/2]

Message AMPS.Client.Message.setOrderBy ( String v )

inline

Set the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results. See the AMPS User Guide for details.

Parameters

v	The ordering expression to set for this Message.

◆ setPassword() [1/2]

Message AMPS.Client.Message.setPassword	(	byte[]	data,
		int	offset,
		int	length
	)

inline

Set the Password on the Message. This field is typically used during the logon sequence.

Parameters

data	The buffer that contains the Password.
offset	The location where the Password starts.
length	The length of the Password.

◆ setPassword() [2/2]

Message AMPS.Client.Message.setPassword ( string password )

inline

Set the password on the Message. This field is typically used during the logon sequence.

Parameters

password The string Password to set on the Message.

◆ setQueryId() [1/3]

Message AMPS.Client.Message.setQueryId	(	byte[]	buffer,
		int	offset,
		int	position
	)

inline

Set the QueryId for this Message. Typically, the QueryId is set for incoming messages by the AMPS Client.

Parameters

buffer	The buffer containing the QueryId.
offset	The location in the buffer where the QueryId begins.
position	The length of the QueryId to be set.

◆ setQueryId() [2/3]

Message AMPS.Client.Message.setQueryId ( CommandId v )

inline

Sets the QueryId for this Message by copying it from a CommandId object. Typically, the QueryId is set for incoming messages by the AMPS Client.

Parameters

v	The CommandId to be set as the QueeryId for this Message.

◆ setQueryId() [3/3]

Message AMPS.Client.Message.setQueryId ( String v )

inline

Sets the QueryId field for this Message. Typically, the QueryId is set by the AMPS client on incoming messages.

Parameters

v	The string to be set as the QueryId for this Message.

◆ setRawBufferLength()

void AMPS.Client.Message.setRawBufferLength ( int length )

inline

Sets the length of the message within the byte buffer.

Parameters

length length of message within the buffer.

◆ setRawBufferOffset()

void AMPS.Client.Message.setRawBufferOffset ( int offset )

inline

Sets the offset into the byte buffer where this message begins.

Parameters

offset offset of first byte of message within the buffer.

◆ setReason()

Message AMPS.Client.Message.setReason ( Reasons v )

inline

Set the Reason value for this Message. Typically, the Reason is set for incoming messages by the AMPS Client.

Parameters

v	The Reason value to set for this Message.

◆ setRecordsDeleted()

Message AMPS.Client.Message.setRecordsDeleted ( long v )

inline

Sets the records deleted header field. This header is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.

Parameters

v	The value to set as the RecordsDeleted field.

◆ setRecordsInserted()

Message AMPS.Client.Message.setRecordsInserted ( long v )

inline

Sets the Records Inserted field. This header is provided on an acknowledgement message. An application typically does not need to set this field. See the AMPS Command Reference for details.

Parameters

v	The value to set as the RecordsInserted field of the Message.

◆ setRecordsReturned()

Message AMPS.Client.Message.setRecordsReturned ( long v )

inline

Sets the RecordsReturned header field.

This header is provided on acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.

Parameters

v	The value to set as the RecordsReturned field.

◆ setRecordsUpdated()

Message AMPS.Client.Message.setRecordsUpdated ( long v )

inline

Sets the RecordsUpdated header field.

This headeer is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.

Parameters

v	The value to set the RecordsUpdated field to.

◆ setSequence()

Message AMPS.Client.Message.setSequence ( ulong v )

inline

Sets the sequence number for this Message.

This field is typically set by the AMPS client. The AMPS client uses the sequence number in outgoing messages. The sequence number is used by AMPS for duplicate detection. Each combination of client name and sequence number should be a unique message.

Parameters

v	The value to set as the sequence number for this Message, in the form of an unsigned long.

◆ setSowKey() [1/2]

Message AMPS.Client.Message.setSowKey	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the SowKey for this Message.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.

Parameters

buffer	The buffer that contains the SOW key.
offset	The location within the buffer where the SOW Key begins.
length	The length of the SOW Key.

◆ setSowKey() [2/2]

Message AMPS.Client.Message.setSowKey ( String v )

inline

Sets the SowKey for this Message.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.

Parameters

v	The string to be used for the SowKey.

◆ setSowKeys() [1/2]

Message AMPS.Client.Message.setSowKeys	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers. This can be useful for commands that operate on multiple SOW records, such as a sow_delete that specifies a set of keys to remove.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS> For messages received from a SOW, AMPS provides the SOW key on each message.

Parameters

buffer	The buffer that contains the SOW Key.
offset	The location within the buffer where the SOW Key begins.
length	The length of the SOW Key.

◆ setSowKeys() [2/2]

Message AMPS.Client.Message.setSowKeys ( String v )

inline

Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers. This can be useful for commands that operate on multiple SOW records, such as a sow_delete that specifies a set of keys to remove.

The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS> For messages received from a SOW, AMPS provides the SOW key on each message.

Parameters

v	A comma-delimited list of identifiers to be set as the SowKeys that this message applies to.

◆ setStatus()

Message AMPS.Client.Message.setStatus ( State v )

inline

Sets the Status of this Message.

This field is provided by AMPS on acknowledgements to indicate the success or failure of the command being acknowledged.

Parameters

v	The value to be set as the Status of the Message.

◆ setSubId() [1/3]

Message AMPS.Client.Message.setSubId	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the SubId of this Message.

The SubId is a reference to the CommandId of the command that created the subscription. For example, messages returned for a subscription contain the SubId of the subscription.

Parameters

buffer	The buffer that contains the SubId key.
offset	The location within the buffer where the SubId begins.
length	The length of the SubId.

◆ setSubId() [2/3]

Message AMPS.Client.Message.setSubId ( CommandId v )

inline

Sets the SubId of this Message by copying it from a CommandId object.

The SubId is the CommandId of the command that created the subscription. For example, to replace a subscription, you provide the SubId of the subscription to be replaced with the command that replaces the subscription.

Parameters

v	The CommandId to be set as the SubId for this Message.

◆ setSubId() [3/3]

Message AMPS.Client.Message.setSubId ( String v )

inline

Sets the SubId of this Message.

The SubId is a reference to the CommandId of the command that created the subscription.

Parameters

v	The string used to set the SubId of this Message.

◆ setSubIds() [1/2]

Message AMPS.Client.Message.setSubIds	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message.

The SubId is the identifier provided when the subscription was registered with AMPS.

Parameters

buffer	The buffer containing the SubIds for this message.
offset	The location of where the SubIds begin.
length	The length of the list of SubIds.

◆ setSubIds() [2/2]

Message AMPS.Client.Message.setSubIds ( String v )

inline

The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list.

The SubId is the identifier provided when the subscription was registered with AMPS.

Parameters

v	The comma-delimited list to be set as the SubIds for this message.

◆ setTimestamp() [1/2]

Message AMPS.Client.Message.setTimestamp	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the timestamp for this message. The timestamp is set by AMPS at the time that AMPS processes the message. There is generally no need to set this field in your application.

Parameters

buffer	the buffer that contains the timestamp
offset	the location within the buffer where the timestamp begins
length	the length of the timestamp

◆ setTimestamp() [2/2]

Message AMPS.Client.Message.setTimestamp ( String v )

inline

Sets the Timestamp for this Message. The timestamp is set by AMPS at the time that AMPS processes the message. There is generally no need to set this field in your application.

<

Parameters

name="v"> The string to set as the Timestamp for this Message.

◆ setTopic() [1/2]

Message AMPS.Client.Message.setTopic	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Set the topic that the message applies to.

Parameters

buffer	the buffer that contains the Topic
offset	the location within the buffer where the Topic begins
length	the length of the Topic

Returns: Returns this instance so that various operations can be chained together.

◆ setTopic() [2/2]

Message AMPS.Client.Message.setTopic ( String v )

inline

Set the topic that the message applies to.

Parameters

v	The string to be set as the Topic that the Message applies to.

Returns: Returns this instance so that various operations can be chained together.

◆ setTopicMatches()

Message AMPS.Client.Message.setTopicMatches ( long v )

inline

Sets the topic matches field on this message. This header is typically provided by AMPS.

Parameters

v	The value to set as the TopicMatches field on this Message.

Returns: Returns this instance so that various operations can be chained together.

◆ setTopN()

Message AMPS.Client.Message.setTopN ( long v )

inline

Set the TopN parameter for this message. For commands that support limiting the number of messages in the result set, this parameter provides the limit to AMPS.

Parameters

v	The value to be set as the TopN parameter.

◆ setUserId()

Message AMPS.Client.Message.setUserId ( String v )

inline

Set the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. Therefore, applications generally only set this value during logon.

Parameters

v	The string to be set as the UserId for this Message.

Returns: Returns this instance so that various operations can be chained together.

◆ setVersion() [1/2]

Message AMPS.Client.Message.setVersion	(	byte[]	buffer,
		int	offset,
		int	length
	)

inline

Sets the version field of this message. This is typically done by the AMPS client API when a message with this field set is received.

Parameters

buffer	the buffer that contains the version string
offset	the position where the version string begins
length	the length of the version string

Returns: Returns this instance so that various operations can be chained together.

◆ setVersion() [2/2]

Message AMPS.Client.Message.setVersion ( String v )

inline

Sets the version field of this message. This is typically done by the AMPS client API when a message with this field set is received.

Parameters

v	The string used to set the Version field of this Message.

Returns: Returns this instance so that various operations can be chained together.

Property Documentation

◆ Client

Client AMPS.Client.Message.Client

get

The Client who allocated this message.

◆ LeasePeriod

String AMPS.Client.Message.LeasePeriod

get

Returns the value of the LeasePeriod field

The documentation for this class was generated from the following files:

AMPS.Client/Message.cs
AMPS.Client/Message.generated.cs

Classes

Public Types

Public Member Functions

Public Attributes

Static Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ AckTypes

◆ Commands

◆ Reasons

◆ State

Member Function Documentation

◆ ack() [1/2]

◆ ack() [2/2]

◆ getAckType()

◆ getAckTypeOutgoing()

◆ getBatchSize()

◆ getBookmark()

◆ getBookmarkRaw()

◆ getBookmarkSeqNo()

◆ getBuffer()

◆ getClient()

◆ getClientName()

◆ getClientNameRaw()

◆ getCommand()

◆ getCommandId() [1/2]

◆ getCommandId() [2/2]

◆ getCommandIdRaw()

◆ getCorrelationId()

◆ getCorrelationIdRaw()

◆ getData()

◆ getDataRaw()

◆ getExpiration()

◆ getExpirationRaw()

◆ getFilter()

◆ getFilterRaw()

◆ getGroupSeqNo()

◆ getLeasePeriod()

◆ getLeasePeriodRaw()

◆ getLength()

◆ getMatches()

◆ getMessageType()

◆ getOptions()

◆ getOptionsRaw()

◆ getOrderBy()

◆ getOrderByRaw()

◆ getPassword()

◆ getPasswordRaw()

◆ getQueryId() [1/2]

◆ getQueryId() [2/2]

◆ getQueryIdRaw()

◆ getRawBufferLength()

◆ getRawBufferOffset()

◆ getReason()

◆ getReasonText()

◆ getRecordsDeleted()

◆ getRecordsInserted()

◆ getRecordsReturned()

◆ getRecordsUpdated()

◆ getSequence()

◆ getSequenceRaw()

◆ getSowKey()

◆ getSowKeyRaw()

◆ getSowKeys()

◆ getSowKeysRaw()

◆ getStatus()

◆ getSubId() [1/2]

◆ getSubId() [2/2]

◆ getSubIdRaw()

◆ getSubIds()

◆ getSubIdsRaw()

◆ getTimestamp()

◆ getTimestampRaw()

◆ getTopic()

◆ getTopicMatches()

◆ getTopicRaw()

◆ getTopN()

◆ getUserId()

◆ getUserIdRaw()