| Pacchetto | mx.messaging.messages |
| Classe | public class CommandMessage |
| Ereditarietà | CommandMessage  AsyncMessage AbstractMessage Object |
| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Nascondi proprietà pubbliche ereditate
Mostra proprietà pubbliche ereditate| Proprietà | Definito da | ||
|---|---|---|---|
 | 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
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto. | 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 | |
| Metodo | Definito da | ||
|---|---|---|---|
Constructs an instance of a CommandMessage with an empty body and header
and a default operation of UNKNOWN_OPERATION. | CommandMessage | ||
[statico]
Provides a description of the operation specified. | CommandMessage | ||
|
Indica se per un oggetto è definita una proprietà specifica. | Object | |
|
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro. | Object | |
|
Indica se la proprietà specificata esiste ed è enumerabile. | Object | |
|
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche. | Object | |
|
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate. | Object | |
[override]
Returns a string representation of the message. | CommandMessage | ||
|
Restituisce il valore di base dell'oggetto specificato. | Object | |
| Costante | Definito da | ||
|---|---|---|---|
| ADD_SUBSCRIPTIONS : String = "DSAddSub" [statico]
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" [statico]
The server message type for authentication commands. | CommandMessage | ||
| CLIENT_PING_OPERATION : uint = 5 [statico]
This operation is used to test connectivity over the current channel to
the remote endpoint. | CommandMessage | ||
| CLIENT_SYNC_OPERATION : uint = 4 [statico]
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 [statico]
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" [statico]
Header to specify which character set encoding was used while encoding
login credentials. | CommandMessage | ||
| DISCONNECT_OPERATION : uint = 12 [statico]
This operation is used to indicate that a channel has disconnected. | CommandMessage | ||
| HEARTBEAT_HEADER : String = "DS<3" [statico]
Header that indicates the message is a heartbeat. | CommandMessage | ||
| LOGIN_OPERATION : uint = 8 [statico]
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 [statico]
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" [statico]
Header to indicate the maximum number of messages a Consumer wants to
receive per second. | CommandMessage | ||
| MESSAGING_VERSION : String = "DSMessagingVersion" [statico]
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 [statico]
Used by the MultiTopicConsumer to subscribe/unsubscribe for more
than one topic in the same message. | CommandMessage | ||
| NEEDS_CONFIG_HEADER : String = "DSNeedsConfig" [statico]
Header to indicate that the Channel needs the configuration from the
server. | CommandMessage | ||
| NO_OP_POLL_HEADER : String = "DSNoOpPoll" [statico]
Header to suppress poll response processing. | CommandMessage | ||
| POLL_OPERATION : uint = 2 [statico]
This operation is used to poll a remote destination for pending,
undelivered messages. | CommandMessage | ||
| POLL_WAIT_HEADER : String = "DSPollWait" [statico]
Header to drive an idle wait time before the next client poll request. | CommandMessage | ||
| PRESERVE_DURABLE_HEADER : String = "DSPreserveDurable" [statico]
Durable JMS subscriptions are preserved when an unsubscribe message
has this parameter set to true in its header. | CommandMessage | ||
| REMOVE_SUBSCRIPTIONS : String = "DSRemSub" [statico]
Like the above, but specifies the subtopic/selector array of to remove
| CommandMessage | ||
| SELECTOR_HEADER : String = "DSSelector" [statico]
Subscribe commands issued by a Consumer pass the Consumer's selector
expression in this header. | CommandMessage | ||
| SUBSCRIBE_OPERATION : uint = 0 [statico]
This operation is used to subscribe to a remote destination. | CommandMessage | ||
| SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10 [statico]
This operation is used to indicate that the client's subscription with a
remote destination has timed out. | CommandMessage | ||
| SUBTOPIC_SEPARATOR : String = "_;_" [statico]
The separator string used for separating subtopic and selectors in the
add and remove subscription headers. | CommandMessage | ||
| TRIGGER_CONNECT_OPERATION : uint = 13 [statico]
This operation is used to trigger a ChannelSet to connect. | CommandMessage | ||
| UNKNOWN_OPERATION : uint = 10000 [statico]
This is the default operation for new CommandMessage instances. | CommandMessage | ||
| UNSUBSCRIBE_OPERATION : uint = 1 [statico]
This operation is used to unsubscribe from a remote destination. | CommandMessage | ||
operation | proprietà |
public var operation:uint| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | () | Funzione di costruzione |
public function CommandMessage()| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | () | metodo |
public static function getOperationAsString(op:uint):String| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Provides a description of the operation specified.
This method is used in toString() operations on this
message.
Parametri
op:uint — One of the CommandMessage operation constants.
|
String — Short name for the operation.
|
Esempio
Come utilizzare questo esempio
var msg:CommandMessage = CommandMessage(event.message);
trace("Current operation -'"+
CommandMessage.getOperationAsString(msg.operation)+ "'.");
toString | () | metodo |
override public function toString():String| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Returns a string representation of the message.
RestituisceString — String representation of the message.
|
ADD_SUBSCRIPTIONS | Costante |
public static const ADD_SUBSCRIPTIONS:String = "DSAddSub"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const AUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
The server message type for authentication commands.
CLIENT_PING_OPERATION | Costante |
public static const CLIENT_PING_OPERATION:uint = 5| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This operation is used to test connectivity over the current channel to the remote endpoint.
CLIENT_SYNC_OPERATION | Costante |
public static const CLIENT_SYNC_OPERATION:uint = 4| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const CLUSTER_REQUEST_OPERATION:uint = 7| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const CREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Header to specify which character set encoding was used while encoding login credentials.
DISCONNECT_OPERATION | Costante |
public static const DISCONNECT_OPERATION:uint = 12| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This operation is used to indicate that a channel has disconnected.
HEARTBEAT_HEADER | Costante |
public static const HEARTBEAT_HEADER:String = "DS<3"Header that indicates the message is a heartbeat.
LOGIN_OPERATION | Costante |
public static const LOGIN_OPERATION:uint = 8| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const LOGOUT_OPERATION:uint = 9| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const MAX_FREQUENCY_HEADER:String = "DSMaxFrequency"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Header to indicate the maximum number of messages a Consumer wants to receive per second.
MESSAGING_VERSION | Costante |
public static const MESSAGING_VERSION:String = "DSMessagingVersion"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const MULTI_SUBSCRIBE_OPERATION:uint = 11| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const NEEDS_CONFIG_HEADER:String = "DSNeedsConfig"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Header to indicate that the Channel needs the configuration from the server.
NO_OP_POLL_HEADER | Costante |
public static const NO_OP_POLL_HEADER:String = "DSNoOpPoll"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const POLL_OPERATION:uint = 2| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This operation is used to poll a remote destination for pending, undelivered messages.
POLL_WAIT_HEADER | Costante |
public static const POLL_WAIT_HEADER:String = "DSPollWait"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Header to drive an idle wait time before the next client poll request.
PRESERVE_DURABLE_HEADER | Costante |
public static const PRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Like the above, but specifies the subtopic/selector array of to remove
SELECTOR_HEADER | Costante |
public static const SELECTOR_HEADER:String = "DSSelector"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Subscribe commands issued by a Consumer pass the Consumer's selector
expression in this header.
SUBSCRIBE_OPERATION | Costante |
public static const SUBSCRIBE_OPERATION:uint = 0| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This operation is used to subscribe to a remote destination.
SUBSCRIPTION_INVALIDATE_OPERATION | Costante |
public static const SUBSCRIPTION_INVALIDATE_OPERATION:uint = 10| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const SUBTOPIC_SEPARATOR:String = "_;_"| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | Costante |
public static const TRIGGER_CONNECT_OPERATION:uint = 13| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This operation is used to trigger a ChannelSet to connect.
UNKNOWN_OPERATION | Costante |
public static const UNKNOWN_OPERATION:uint = 10000| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This is the default operation for new CommandMessage instances.
UNSUBSCRIBE_OPERATION | Costante |
public static const UNSUBSCRIBE_OPERATION:uint = 1| Versione linguaggio: | ActionScript 3.0 |
| Versioni prodotto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
This operation is used to unsubscribe from a remote destination.
Tue Jun 12 2018, 02:44 PM Z