AMPS Protocol
AMPS Protocol
The following table describes how the headers in the amps
protocol are processed by AMPS.
Current releases of AMPS use a simplified JSON-like syntax for the amps
protocol.
AMPS Message Header - Sorted by Name
AMPS Header Field | Abbreviation | Name |
ack_type | a |
|
password | pw |
|
bookmark | bm |
|
batch_size | bs |
|
client_name |
| |
cmd | c |
|
cmd_id | cid |
|
correlation_id | x |
|
data_only |
| |
expiration | e |
|
filter | f |
|
gseq |
| |
heartbeat |
| |
leaseperiod | lp |
|
matches |
| |
msg_len | l |
|
max_msgs |
| |
opts | o |
|
orderby |
| |
query_id |
| |
reason |
| |
records_deleted |
| |
records_inserted |
| |
records_returned |
| |
records_updated |
| |
seq | s |
|
send_empty |
| |
send_keys |
| |
send_oof |
| |
sow_key | k |
|
sow_keys |
| |
status |
| |
sub_id |
| |
sids |
| |
src |
| |
timeout_interval |
| |
timestamp | ts |
|
top_n |
| |
topic_matches |
| |
topic | t |
|
use_ns |
| |
user_id |
| |
version | v |
|
Header Fields - Reference
This section provides a reference to the header fields that have been used in AMPS messages. Not all headers are present on all outgoing messages, and not all headers are processed on incoming commands. See the detailed message descriptions in this guide for descriptions of which fields are used on a given command or a given response from AMPS. Further, although this table lists the header fields defined in every protocol, current versions of AMPS may not use every header defined in this table (see the detailed message descriptions for which fields are relevant for a given command or response).
Name | Type | Definition |
| string | Acknowledgment type for the given command. |
| integer Default is 1 when not present. | Specifies the number of messages that are batched together when returning a query result. |
| string | A client-originated identifier used to mark a location in journaled messages. |
| string | Used to identify a client. Useful for publishers that wish to identify the source of a publish, client status messages and for client heartbeats. Can be set with |
| One of:
| Command to be executed. |
| string | Client-specified command ID. The |
| string, base64 encoded characters only | Opaque token set by an application and returned with the message. |
| Boolean ( | If |
| integer (seconds) | SOW expiration time if used in |
| string, should wrap in CDATA | Content filter expression. |
| integer (milliseconds) | Grace period after heartbeat interval is exceeded before client is considered in error state. |
| integer | Group Sequence Number returned with each batch message of a SOW response. |
| One of:
| Heartbeat command. |
| timestamp | For messages from a queue, the time at which the lease expires. |
| One of:
| Set the log level. Deprecated Not used in current versions of AMPS. |
| integer | Returned in the acknowledgment to a SOW query that indicates number of matches. |
| integer greater than zero | Specifies the maximum number of messages within a batch publish. |
| string, e.g. | Set by AMPS engine to tag every incoming message. |
| integer | Sent with messages that have data (a message body) to indicate the number of bytes in the message body. |
| string One of the configured message types in AMPS. | Message type. |
| integer | Sent with messages that have data (a message body) to indicate the number of bytes in the message body. |
| string | A comma-delimited list of options on a specific command. |
| string | Password used to authenticate with an AMPS server. |
| string | SOW query identifier set by client to identify a query. |
| string | The failure message that appears when an acknowledgment returns a |
| integer | Used in conjunction with the |
| integer | Used in conjunction with the |
| integer | Used in conjunction with the |
| integer | Returned in the acknowledgment to an SOW query that indicates number of records in the store. |
| Boolean ( | If |
| Boolean ( | Option to instruct AMPS that a client would like to receive the |
| Boolean ( | If |
| Boolean ( | If |
| integer greater than zero | An integer that corresponds to the publish message sequence number. For more information see the Replicating Messages Between Instances chapter in the AMPS User Guide. |
| string containing the digits of an unsigned long for AMPS-generated SOW keys arbitrary string in the base64 character set for user-provided SOW keys | A A A |
| comma-separated list of | Comma-separated list of |
| One of:
| Used to indicate client status when client is monitored for heartbeats. |
| string, e.g. | The subscription identifier set by server when processing a subscription. |
| string | Comma-separated list of |
| integer | Used in conjunction with the heartbeat interval to set the timeout interval for a publisher. |
| unsigned integer | The number of records to return. Note: If |
| string | Topic |
| integer | Returned in the acknowledgment to an SOW query that indicates number of topic matches. |
| ISO-8601 date-time | Timestamp - Optionally set to time the message was processed by the server. |
| Boolean ( | Use SOAP XML namespaces in all messages from the AMPS engine. |
| string | Used to identify the user ID of a command. |
| string | Contains the version of the AMPS server. |
Last updated