Gitee
\

\Zend_Amf_Value_Messaging_CommandMessage

A message that represents an infrastructure command passed between client and server. Subscribe/unsubscribe operations result in CommandMessage transmissions, as do polling operations.

Corresponds to flex.messaging.messages.CommandMessage

Note: THESE VALUES MUST BE THE SAME ON CLIENT AND SERVER

Summary

Methods
Properties
Constants
generateId()
$correlationId
$clientId
$destination
$messageId
$timestamp
$timeToLive
$headers
$body
$operation
SUBSCRIBE_OPERATION
UNSUSBSCRIBE_OPERATION
POLL_OPERATION
CLIENT_SYNC_OPERATION
CLIENT_PING_OPERATION
CLUSTER_REQUEST_OPERATION
LOGIN_OPERATION
LOGOUT_OPERATION
SESSION_INVALIDATE_OPERATION
MULTI_SUBSCRIBE_OPERATION
DISCONNECT_OPERATION
UNKNOWN_OPERATION
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

SUBSCRIBE_OPERATION

SUBSCRIBE_OPERATION = 0

This operation is used to subscribe to a remote destination.

@const int

UNSUSBSCRIBE_OPERATION

UNSUSBSCRIBE_OPERATION = 1

This operation is used to unsubscribe from a remote destination.

POLL_OPERATION

POLL_OPERATION = 2

This operation is used to poll a remote destination for pending, undelivered messages.

CLIENT_SYNC_OPERATION

CLIENT_SYNC_OPERATION = 4

This operation is used by a remote destination to sync missed or cached messages back to a client as a result of a client issued poll command.

CLIENT_PING_OPERATION

CLIENT_PING_OPERATION = 5

This operation is used to test connectivity over the current channel to the remote endpoint.

CLUSTER_REQUEST_OPERATION

CLUSTER_REQUEST_OPERATION = 7

This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.

LOGIN_OPERATION

LOGIN_OPERATION = 8

This operation is used to send credentials to the endpoint so that the user can be logged in over the current channel.

The credentials need to be Base64 encoded and stored in the body of the message.

LOGOUT_OPERATION

LOGOUT_OPERATION = 9

This operation is used to log the user out of the current channel, and will invalidate the server session if the channel is HTTP based.

SESSION_INVALIDATE_OPERATION

SESSION_INVALIDATE_OPERATION = 10

This operation is used to indicate that the client's subscription to a remote destination has been invalidated.

MULTI_SUBSCRIBE_OPERATION

MULTI_SUBSCRIBE_OPERATION = 11

This operation is used by the MultiTopicConsumer to subscribe/unsubscribe from multiple subtopics/selectors in the same message.

DISCONNECT_OPERATION

DISCONNECT_OPERATION = 12

This operation is used to indicate that a channel has disconnected

UNKNOWN_OPERATION

UNKNOWN_OPERATION = 10000

This is the default operation for new CommandMessage instances.

Properties

$correlationId

$correlationId : String

The message id to be responded to.

Type

String

$clientId

$clientId : string

Type

string — Client identifier

$destination

$destination : string

Type

string — Destination

$messageId

$messageId : string

Type

string — Message identifier

$timestamp

$timestamp : integer

Type

integer — Message timestamp

$timeToLive

$timeToLive : integer

Type

integer — Message TTL

$headers

$headers : object

Type

object — Message headers

$body

$body : string

Type

string — Message body

$operation

$operation : integer

The operation to execute for messages of this type

Type

integer

Methods

generateId()

generateId() : string

generate a unique id

Format is: ########-####-####-####-############ Where # is an uppercase letter or number example: 6D9DC7EC-A273-83A9-ABE3-00005FD752D6

Returns

string