AMPS.Client.JSONMessage Class Reference
A message subclass used by JSONProtocolParser to aid in building Message instances parsed from the JSONProtoco (i.e. the "amps" transport protocol). Generally not used directly by the end user. More...
Inheritance diagram for AMPS.Client.JSONMessage:
Public Member Functions | |
| JSONMessage (Encoding encoder, Encoding decoder) | |
| Initializes a new instance of the JSONMessage class. More... | |
| override SerializationResult | serialize (MemoryStream b) |
| Serializes the JSON message into the specified memory stream. More... | |
| override Message | copy () |
| Makes and returns a deep copy of this JSONMessage. More... | |
| Public Member Functions inherited from AMPS.Client.Message | |
| Message (Encoding encoder, Encoding decoder) | |
| void | setBookmarkSeqNo (long val) |
| This field is only used internally by bookmark store implementations to cache a tracking index for undiscarded messages, so they can be look up quickly when discarded for a bookmark subscription. There is generally no reason for end-user applications to use this. Sets the bookmark sequence number for this message. More... | |
| long | getBookmarkSeqNo () |
| Returns the bookmark sequence number for this message. This field is only used internally by bookmark store implementations to cache a tracking index for undiscarded messages, so they can be looked up quickly when discarded for a bookmark subscription. There is generally no reason for end-user applications to use this. More... | |
| abstract SerializationResult | serialize (System.IO.MemoryStream buffer) |
| Serializes this message into the provided byte buffer at its current position. More... | |
| 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 on this Message by copying it into the provided CommandId object. 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 field 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 set 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 messages 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. More... | |
| 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 () |
| void | setBuffer (byte[] buffer) |
| byte[] | getBuffer () |
| Gets the byte buffer used by the message. More... | |
| void | setRawBufferOffset (int offset) |
| Sets the offset into the byte buffer where this message begins. More... | |
| int | getRawBufferOffset () |
| Gets the offset into the byte buffer where this message begins. More... | |
| void | setRawBufferLength (int length) |
| Sets the length of the message within the byte buffer. More... | |
| int | getRawBufferLength () |
| Gets the length of the message within the byte buffer. More... | |
| 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 () |
| Used to check if automatic acking of this Message by the Client should be skipped. More... | |
| void | setIgnoreAutoAck () |
| Used to disable automatic acking of this Message by the Client after the (check this again, wether the path of the link is correct or not) AMPS.Client.MessageHandler completes. More... | |
Additional Inherited Members | |
| Public Types inherited from AMPS.Client.Message | |
| 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() AMPS.Client.Command::addAckType() AMPS.Client.Fields.AckTypeField 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 , 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 } |
| Returned by calls to serialize(ByteBuffer) More... | |
| Public Attributes inherited from AMPS.Client.Message | |
| Encoding | encoder = null |
| Encoding | decoder = null |
| StringField | _Version = new StringField() |
| Static Protected Attributes inherited from AMPS.Client.Message | |
| const int | MINIMUM_SERVER_VERSION = Client.DEFAULT_SERVER_VERSION |
| Properties inherited from AMPS.Client.Message | |
| 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] |
| Gets or sets the group sequence number. More... | |
| Int64 | Matches [get, set] |
| Gets or sets the number of matches. More... | |
| Int32 | Length [get, set] |
| Gets or sets the length of the message. More... | |
| String | QueryId [get, set] |
| Gets or sets the query ID. More... | |
| Reasons | Reason [get, set] |
| Gets or sets the reason. More... | |
| Int64 | RecordsInserted [get, set] |
| Gets or sets the number of records inserted. More... | |
| Int64 | RecordsUpdated [get, set] |
| Gets or sets the number of records updated. More... | |
| Int64 | RecordsDeleted [get, set] |
| Gets or sets the number of records deleted. More... | |
| Int64 | RecordsReturned [get, set] |
| Gets or sets the number of records returned. More... | |
| UInt64 | Sequence [get, set] |
| Gets or sets the sequence. More... | |
| String | SowKey [get, set] |
| Gets or sets the SOW key. More... | |
| String | SowKeys [get, set] |
| Gets or sets the SOW keys. More... | |
| State | Status [get, set] |
| Gets or sets the status. More... | |
| String | SubId [get, set] |
| Gets or sets the subscription ID. More... | |
| String | SubIds [get, set] |
| Gets or sets the subscription IDs. More... | |
| String | Timestamp [get, set] |
| Gets or sets the timestamp. More... | |
| Int64 | TopN [get, set] |
| Gets or sets the top N value. More... | |
| String | Topic [get, set] |
| Gets or sets the topic. More... | |
| Int64 | TopicMatches [get, set] |
| Gets or sets the number of matches for a topic. More... | |
| String | UserId [get, set] |
| Gets or sets the user ID. More... | |
| String | Password [get, set] |
| Gets or sets the password. More... | |
| String | Data [get, set] |
| Gets or sets the data. More... | |
| AckTypes | AckType [get, set] |
| Gets or sets the acknowledgement type. More... | |
| Int32 | BatchSize [get, set] |
| Gets or sets the batch size. More... | |
| String | Bookmark [get, set] |
| Gets or sets the bookmark. More... | |
| String | ClientName [get, set] |
| Gets or sets the client name. More... | |
| String | CommandId [get, set] |
| Gets or sets the command ID. More... | |
| Commands | Command [get, set] |
| Gets or sets the command. More... | |
| Int32 | Expiration [get, set] |
| Gets or sets the expiration time. More... | |
| String | Filter [get, set] |
| Gets or sets the filter. More... | |
| String | OrderBy [get, set] |
| Gets or sets the order by clause. More... | |
| String | CorrelationId [get, set] |
| Gets or sets the correlation ID. More... | |
Detailed Description
A message subclass used by JSONProtocolParser to aid in building Message instances parsed from the JSONProtoco (i.e. the "amps" transport protocol). Generally not used directly by the end user.
Constructor & Destructor Documentation
◆ JSONMessage()
|
inline |
Initializes a new instance of the JSONMessage class.
- Parameters
-
encoder The encoding used for the message. decoder The decoding used for the message.
Member Function Documentation
◆ copy()
|
inlinevirtual |
Makes and returns a deep copy of this JSONMessage.
- Returns
- A copy of the JSON message.
Implements AMPS.Client.Message.
◆ serialize()
|
inline |
Serializes the JSON message into the specified memory stream.
- Parameters
-
b The memory stream to write the serialized message to.
- Returns
- The serialization result.
The documentation for this class was generated from the following file:
- AMPS.Client/JSONMessage.cs
