class CommandMessage
package feathers.messaging.messages
extends AsyncMessage › AbstractMessage
The CommandMessage class provides a mechanism for sending commands to the server infrastructure, such as commands related to publish/subscribe messaging scenarios, ping operations, and cluster operations.
Static variables
staticfinalread onlyADD_SUBSCRIPTIONS:String = "DSAddSub"
Header used in a MULTI_SUBSCRIBE message to specify an Array of subtopic/selector pairs to add to the existing set of subscriptions.
staticfinalread onlyAUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"
The server message type for authentication commands.
staticfinalread onlyCLIENT_PING_OPERATION:UInt = 5
This operation is used to test connectivity over the current channel to he remote endpoint.
staticfinalread onlyCLIENT_SYNC_OPERATION:UInt = 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.
staticfinalread onlyCLUSTER_REQUEST_OPERATION:UInt = 7
This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.
staticfinalread onlyCREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"
Header to specify which character set encoding was used while encoding login credentials.
staticfinalread onlyDISCONNECT_OPERATION:UInt = 12
This operation is used to indicate that a channel has disconnected.
staticfinalread onlyHEARTBEAT_HEADER:String = "DS<3"
Header that indicates the message is a heartbeat.
staticfinalread onlyLOGIN_OPERATION:UInt = 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.
staticfinalread onlyLOGOUT_OPERATION:UInt = 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.
staticfinalread onlyMAX_FREQUENCY_HEADER:String = "DSMaxFrequency"
Header to indicate the maximum number of messages a Consumer wants to receive per second.
staticfinalread onlyMESSAGING_VERSION:String = "DSMessagingVersion"
Endpoints can imply what features they support by reporting the latest version of messaging they are capable of during the handshake of the initial ping CommandMessage.
staticfinalread onlyMULTI_SUBSCRIBE_OPERATION:UInt = 11
Used by the MultiTopicConsumer to subscribe/unsubscribe for more than one topic in the same message.
staticfinalread onlyNEEDS_CONFIG_HEADER:String = "DSNeedsConfig"
Header to indicate that the Channel needs the configuration from the server.
staticfinalread onlyNO_OP_POLL_HEADER:String = "DSNoOpPoll"
Header to suppress poll response processing. If a client has a long-poll parked on the server and issues another poll, the response to this subsequent poll should be tagged with this header in which case the response is treated as a no-op and the next poll will not be scheduled. Without this, a subsequent poll will put the channel and endpoint into a busy polling cycle.
staticfinalread onlyPOLL_OPERATION:UInt = 2
This operation is used to poll a remote destination for pending, undelivered messages.
staticfinalread onlyPOLL_WAIT_HEADER:String = "DSPollWait"
Header to drive an idle wait time before the next client poll request.
staticfinalread onlyPRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"
Durable JMS subscriptions are preserved when an unsubscribe message has this parameter set to true in its header.
staticfinalread onlyREMOVE_SUBSCRIPTIONS:String = "DSRemSub"
Like the above, but specifies the subtopic/selector array of to remove
staticfinalread onlySELECTOR_HEADER:String = "DSSelector"
Subscribe commands issued by a Consumer pass the Consumer's selector
expression in this header.
staticfinalread onlySUBSCRIBE_OPERATION:UInt = 0
This operation is used to subscribe to a remote destination.
staticfinalread onlySUBSCRIPTION_INVALIDATE_OPERATION:UInt = 10
This operation is used to indicate that the client's subscription with a remote destination has timed out.
staticfinalread onlySUBTOPIC_SEPARATOR:String = "_;_"
The separator string used for separating subtopic and selectors in the add and remove subscription headers.
staticfinalread onlyTRIGGER_CONNECT_OPERATION:UInt = 13
This operation is used to trigger a ChannelSet to connect.
staticfinalread onlyUNKNOWN_OPERATION:UInt = 10000
This is the default operation for new CommandMessage instances.
staticfinalread onlyUNSUBSCRIBE_OPERATION:UInt = 1
This operation is used to unsubscribe from a remote destination.
Static methods
staticgetOperationAsString(op:UInt):String
Provides a description of the operation specified.
This method is used in toString() operations on this
message.
Parameters:
op | One of the CommandMessage operation constants. |
|---|
Returns:
Short name for the operation.
var msg = cast(event.message, CommandMessage);
trace("Current operation -'" +
CommandMessage.getOperationAsString(msg.operation)+ "'.");Constructor
new()
Constructs an instance of a CommandMessage with an empty body and header
and a default operation of UNKNOWN_OPERATION.
Variables
operation:UInt
Provides access to the operation/command for the CommandMessage. Operations indicate how this message should be processed by the remote destination.
Methods
toString():String
Returns a string representation of the message.
Returns:
String representation of the message.