| Pakket | mx.messaging.messages |
| Klasse | public class CommandMessage |
| Overerving | CommandMessage  AsyncMessage AbstractMessage Object |
| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Overerfde openbare eigenschappen verbergen
Overerfde openbare eigenschappen weergeven| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
 | body : Object
The body of a message contains the specific data that needs to be
delivered to the remote destination. | AbstractMessage | |
| clientId : String
The clientId indicates which MessageAgent sent the message. | AbstractMessage | |
| constructor : Object
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | Object | |
| correlationId : String
Provides access to the correlation id of the message. | AsyncMessage | |
| destination : String
The message destination. | AbstractMessage | |
| headers : Object
The headers of a message are an associative array where the key is the
header name and the value is the header value. | AbstractMessage | |
| messageId : String
The unique id for the message. | AbstractMessage | |
| operation : uint
Provides access to the operation/command for the CommandMessage. | CommandMessage | ||
| timestamp : Number
Provides access to the time stamp for the message. | AbstractMessage | |
| timeToLive : Number
The time to live value of a message indicates how long the message
should be considered valid and deliverable. | AbstractMessage | |
| Methode | Gedefinieerd door | ||
|---|---|---|---|
Constructs an instance of a CommandMessage with an empty body and header
and a default operation of UNKNOWN_OPERATION. | CommandMessage | ||
[statisch]
Provides a description of the operation specified. | CommandMessage | ||
|
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | |
|
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | |
|
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | |
|
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | |
|
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | |
[overschrijven]
Returns a string representation of the message. | CommandMessage | ||
|
Retourneert de primitieve waarde van het opgegeven object. | Object | |
| Constante | Gedefinieerd door | ||
|---|---|---|---|
| ADD_SUBSCRIPTIONS : String = "DSAddSub" [statisch]
Header used in a MULTI_SUBSCRIBE message to specify an Array of subtopic/selector
pairs to add to the existing set of subscriptions. | CommandMessage | ||
| AUTHENTICATION_MESSAGE_REF_TYPE : String = "flex.messaging.messages.AuthenticationMessage" [statisch]
The server message type for authentication commands. | CommandMessage | ||
| CLIENT_PING_OPERATION : uint = 5 [statisch]
This operation is used to test connectivity over the current channel to
the remote endpoint. | CommandMessage | ||
| CLIENT_SYNC_OPERATION : uint = 4 [statisch]
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. | CommandMessage | ||
| CLUSTER_REQUEST_OPERATION : uint = 7 [statisch]
This operation is used to request a list of failover endpoint URIs
for the remote destination based on cluster membership. | CommandMessage | ||
| CREDENTIALS_CHARSET_HEADER : String = "DSCredentialsCharset" [statisch]
Header to specify which character set encoding was used while encoding
login credentials. | CommandMessage | ||
| DISCONNECT_OPERATION : uint = 12 [statisch]
This operation is used to indicate that a channel has disconnected. | CommandMessage | ||
| HEARTBEAT_HEADER : String = "DS<3" [statisch]
Header that indicates the message is a heartbeat. | CommandMessage | ||
| LOGIN_OPERATION : uint = 8 [statisch]
This operation is used to send credentials to the endpoint so that
the user can be logged in over the current channel. | CommandMessage | ||
| LOGOUT_OPERATION : uint = 9 [statisch]
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. | CommandMessage | ||
| MAX_FREQUENCY_HEADER : String = "DSMaxFrequency" [statisch]
Header to indicate the maximum number of messages a Consumer wants to
receive per second. | CommandMessage | ||
| MESSAGING_VERSION : String = "DSMessagingVersion" [statisch]
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. | CommandMessage | ||
| MULTI_SUBSCRIBE_OPERATION : uint = 11 [statisch]
Used by the MultiTopicConsumer to subscribe/unsubscribe for more
than one topic in the same message. | CommandMessage | ||
| NEEDS_CONFIG_HEADER : String = "DSNeedsConfig" [statisch]
Header to indicate that the Channel needs the configuration from the
server. | CommandMessage | ||
| NO_OP_POLL_HEADER : String = "DSNoOpPoll" [statisch]
Header to suppress poll response processing. | CommandMessage | ||
| POLL_OPERATION : uint = 2 [statisch]
This operation is used to poll a remote destination for pending,
undelivered messages. | CommandMessage | ||
| POLL_WAIT_HEADER : String = "DSPollWait" [statisch]
Header to drive an idle wait time before the next client poll request. | CommandMessage | ||
| PRESERVE_DURABLE_HEADER : String = "DSPreserveDurable" [statisch]
Durable JMS subscriptions are preserved when an unsubscribe message
has this parameter set to true in its header. | CommandMessage | ||
| REMOVE_SUBSCRIPTIONS : String = "DSRemSub" [statisch]
Like the above, but specifies the subtopic/selector array of to remove
| CommandMessage | ||
| SELECTOR_HEADER : String = "DSSelector" [statisch]
Subscribe commands issued by a Consumer pass the Consumer's selector
expression in this header. | CommandMessage | ||
| SUBSCRIBE_OPERATION : uint = 0 [statisch]
This operation is used to subscribe to a remote destination. | CommandMessage | ||
| SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10 [statisch]
This operation is used to indicate that the client's subscription with a
remote destination has timed out. | CommandMessage | ||
| SUBTOPIC_SEPARATOR : String = "_;_" [statisch]
The separator string used for separating subtopic and selectors in the
add and remove subscription headers. | CommandMessage | ||
| TRIGGER_CONNECT_OPERATION : uint = 13 [statisch]
This operation is used to trigger a ChannelSet to connect. | CommandMessage | ||
| UNKNOWN_OPERATION : uint = 10000 [statisch]
This is the default operation for new CommandMessage instances. | CommandMessage | ||
| UNSUBSCRIBE_OPERATION : uint = 1 [statisch]
This operation is used to unsubscribe from a remote destination. | CommandMessage | ||
operation | eigenschap |
public var operation:uint| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Provides access to the operation/command for the CommandMessage. Operations indicate how this message should be processed by the remote destination.
CommandMessage | () | Constructor |
public function CommandMessage()| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Constructs an instance of a CommandMessage with an empty body and header
and a default operation of UNKNOWN_OPERATION.
getOperationAsString | () | methode |
public static function getOperationAsString(op:uint):String| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Provides a description of the operation specified.
This method is used in toString() operations on this
message.
Parameters
op:uint — One of the CommandMessage operation constants.
|
String — Short name for the operation.
|
Voorbeeld
Hoe dit voorbeeld te gebruiken
var msg:CommandMessage = CommandMessage(event.message);
trace("Current operation -'"+
CommandMessage.getOperationAsString(msg.operation)+ "'.");
toString | () | methode |
override public function toString():String| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Returns a string representation of the message.
Geretourneerde waardeString — String representation of the message.
|
ADD_SUBSCRIPTIONS | Constante |
public static const ADD_SUBSCRIPTIONS:String = "DSAddSub"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Header used in a MULTI_SUBSCRIBE message to specify an Array of subtopic/selector pairs to add to the existing set of subscriptions.
AUTHENTICATION_MESSAGE_REF_TYPE | Constante |
public static const AUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The server message type for authentication commands.
CLIENT_PING_OPERATION | Constante |
public static const CLIENT_PING_OPERATION:uint = 5| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to test connectivity over the current channel to the remote endpoint.
CLIENT_SYNC_OPERATION | Constante |
public static const CLIENT_SYNC_OPERATION:uint = 4| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
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.
CLUSTER_REQUEST_OPERATION | Constante |
public static const CLUSTER_REQUEST_OPERATION:uint = 7| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.
CREDENTIALS_CHARSET_HEADER | Constante |
public static const CREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Header to specify which character set encoding was used while encoding login credentials.
DISCONNECT_OPERATION | Constante |
public static const DISCONNECT_OPERATION:uint = 12| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to indicate that a channel has disconnected.
HEARTBEAT_HEADER | Constante |
public static const HEARTBEAT_HEADER:String = "DS<3"Header that indicates the message is a heartbeat.
LOGIN_OPERATION | Constante |
public static const LOGIN_OPERATION:uint = 8| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
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 | Constante |
public static const LOGOUT_OPERATION:uint = 9| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
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.
MAX_FREQUENCY_HEADER | Constante |
public static const MAX_FREQUENCY_HEADER:String = "DSMaxFrequency"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Header to indicate the maximum number of messages a Consumer wants to receive per second.
MESSAGING_VERSION | Constante |
public static const MESSAGING_VERSION:String = "DSMessagingVersion"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
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.
MULTI_SUBSCRIBE_OPERATION | Constante |
public static const MULTI_SUBSCRIBE_OPERATION:uint = 11| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Used by the MultiTopicConsumer to subscribe/unsubscribe for more than one topic in the same message.
NEEDS_CONFIG_HEADER | Constante |
public static const NEEDS_CONFIG_HEADER:String = "DSNeedsConfig"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Header to indicate that the Channel needs the configuration from the server.
NO_OP_POLL_HEADER | Constante |
public static const NO_OP_POLL_HEADER:String = "DSNoOpPoll"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
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.
POLL_OPERATION | Constante |
public static const POLL_OPERATION:uint = 2| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to poll a remote destination for pending, undelivered messages.
POLL_WAIT_HEADER | Constante |
public static const POLL_WAIT_HEADER:String = "DSPollWait"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Header to drive an idle wait time before the next client poll request.
PRESERVE_DURABLE_HEADER | Constante |
public static const PRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Durable JMS subscriptions are preserved when an unsubscribe message has this parameter set to true in its header.
REMOVE_SUBSCRIPTIONS | Constante |
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Like the above, but specifies the subtopic/selector array of to remove
SELECTOR_HEADER | Constante |
public static const SELECTOR_HEADER:String = "DSSelector"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Subscribe commands issued by a Consumer pass the Consumer's selector
expression in this header.
SUBSCRIBE_OPERATION | Constante |
public static const SUBSCRIBE_OPERATION:uint = 0| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to subscribe to a remote destination.
SUBSCRIPTION_INVALIDATE_OPERATION | Constante |
public static const SUBSCRIPTION_INVALIDATE_OPERATION:uint = 10| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to indicate that the client's subscription with a remote destination has timed out.
SUBTOPIC_SEPARATOR | Constante |
public static const SUBTOPIC_SEPARATOR:String = "_;_"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The separator string used for separating subtopic and selectors in the add and remove subscription headers.
TRIGGER_CONNECT_OPERATION | Constante |
public static const TRIGGER_CONNECT_OPERATION:uint = 13| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to trigger a ChannelSet to connect.
UNKNOWN_OPERATION | Constante |
public static const UNKNOWN_OPERATION:uint = 10000| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This is the default operation for new CommandMessage instances.
UNSUBSCRIBE_OPERATION | Constante |
public static const UNSUBSCRIBE_OPERATION:uint = 1| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
This operation is used to unsubscribe from a remote destination.
Wed Jun 13 2018, 11:42 AM Z