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
package |
Zend_Amf |
subpackage |
Value |
copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license |
New BSD License |
inherited_from |
\Zend_Amf_Value_Messaging_AsyncMessage |
Methods
generate a unique id
generateId() : string
Inherited
Format is: ########-####-####-####-############
Where # is an uppercase letter or number
example: 6D9DC7EC-A273-83A9-ABE3-00005FD752D6
Returns
string
Properties
Message body
$body : string
Client identifier
$clientId : string
The message id to be responded to.
$correlationId : String
Destination
$destination : string
Message identifier
$messageId : string
The operation to execute for messages of this type
$operation : integer
Default
self::UNKNOWN_OPERATION
Message TTL
$timeToLive : integer
Message timestamp
$timestamp : integer
Constants
This operation is used to test connectivity over the current channel to
the remote endpoint.
CLIENT_PING_OPERATION = 5
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_SYNC_OPERATION = 4
This operation is used to request a list of failover endpoint URIs
for the remote destination based on cluster membership.
CLUSTER_REQUEST_OPERATION = 7
This operation is used to indicate that a channel has disconnected
DISCONNECT_OPERATION = 12
This operation is used to send credentials to the endpoint so that
the user can be logged in over the current channel.
LOGIN_OPERATION = 8
The credentials need to be Base64 encoded and stored in the body
of the message.
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.
LOGOUT_OPERATION = 9
This operation is used by the MultiTopicConsumer to subscribe/unsubscribe
from multiple subtopics/selectors in the same message.
MULTI_SUBSCRIBE_OPERATION = 11
This operation is used to poll a remote destination for pending,
undelivered messages.
POLL_OPERATION = 2
This operation is used to indicate that the client's subscription to a
remote destination has been invalidated.
SESSION_INVALIDATE_OPERATION = 10
This operation is used to subscribe to a remote destination.
SUBSCRIBE_OPERATION = 0
This is the default operation for new CommandMessage instances.
UNKNOWN_OPERATION = 10000
This operation is used to unsubscribe from a remote destination.
UNSUSBSCRIBE_OPERATION = 1