Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
AsyncRequest

Package | mx.rpc
Class | public class AsyncRequest
Inheritance | AsyncRequest Producer AbstractProducer MessageAgent flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The AsyncRequest class provides an abstraction of messaging for RPC call invocation. An AsyncRequest allows multiple requests to be made on a remote destination and will call back to the responder specified within the request when the remote request is completed.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | authenticated : Boolean [read-only] Indicates if this MessageAgent is using an authenticated connection to its destination. | MessageAgent
|  | autoConnect : Boolean If true the Producer automatically connects to its destination the first time the send() method is called. | AbstractProducer
|  | channelSet : ChannelSet Provides access to the ChannelSet used by the MessageAgent. | MessageAgent
|  | clientId : String [read-only] Provides access to the client id for the MessageAgent. | MessageAgent
|  | connected : Boolean [read-only] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet. | MessageAgent
|  | defaultHeaders : Object The default headers to apply to messages sent by the Producer. | AbstractProducer
|  | destination : String Provides access to the destination for the MessageAgent. | MessageAgent
|  | priority : int The default message priority for the messages sent by the Producer. | AbstractProducer
|  | reconnectAttempts : int The number of reconnect attempts that the Producer makes in the event that the destination is unavailable or the connection to the destination closes. | AbstractProducer
|  | reconnectInterval : int The number of milliseconds between reconnect attempts. | AbstractProducer
|  | requestTimeout : int Provides access to the request timeout in seconds for sent messages. | MessageAgent
|  | subtopic : String Provides access to the subtopic for the remote destination that the MessageAgent uses. | Producer

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AsyncRequest() Constructs a new asynchronous request. | AsyncRequest
|  | acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a result for a sent message. | MessageAgent
|  | channelConnectHandler(event:ChannelEvent):void Handles a CONNECT ChannelEvent. | MessageAgent
|  | channelDisconnectHandler(event:ChannelEvent):void Handles a DISCONNECT ChannelEvent. | MessageAgent
|  | channelFaultHandler(event:ChannelFaultEvent):void Handles a ChannelFaultEvent. | MessageAgent
|  | connect():void Connects the Producer to its target destination. | AbstractProducer
|  | disconnect():void [override] Disconnects the Producer from its remote destination. | AbstractProducer
|  | fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent
|  | hasPendingRequestForMessage(msg:IMessage):Boolean [override] Returns true if there are any pending requests for the passed in message. | AsyncRequest
|  | initialized(document:Object, id:String):void Called after the implementing object has been created and all properties specified on the tag have been assigned. | MessageAgent
|  | invoke(msg:IMessage, responder:IResponder):void Dispatches the asynchronous request and stores the responder to call later. | AsyncRequest
|  | logout():void Logs the MessageAgent out from its remote destination. | MessageAgent
|  | send(message:IMessage):void Sends the specified message to its destination. | AbstractProducer
|  | setCredentials(username:String, password:String, charset:String = null):void Sets the credentials that the MessageAgent uses to authenticate to destinations. | MessageAgent
|  | setRemoteCredentials(username:String, password:String, charset:String = null):void Sets the remote credentials that will be passed through to the remote destination for authenticating to secondary systems. | MessageAgent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Handles the authentication fault on the server. | MessageAgent
|  | initChannelSet(message:IMessage):void Used to automatically initialize the channelSet property for the MessageAgent before it connects for the first time. | MessageAgent
|  | internalSend(message:IMessage, waitForClientId:Boolean = true):void Sends a Message from the MessageAgent to its destination using the agent's ChannelSet. | MessageAgent
|  | reAuthorize(msg:IMessage):void This function should be overriden by sublasses to implement reauthentication due to server session time-out behavior specific to them. | MessageAgent

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | acknowledge | Dispatched when an acknowledge message is received for a sent message. | MessageAgent
|  | channelConnect | Dispatched when the underlying Channel the MessageAgent is using connects. | MessageAgent
|  | channelDisconnect | Dispatched when the underlying Channel the MessageAgent is using disconnects. | MessageAgent
|  | channelFault | Dispatched when the underlying Channel the MessageAgent is using faults. | MessageAgent
|  | fault | Dispatched when a message fault occurs. | MessageAgent
|  | propertyChange | Dispatched when the connected property of the MessageAgent changes. | MessageAgent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_PRIORITY : int = 4 [static] The default message priority. | Producer

Constructor Detail

AsyncRequest | () | Constructor

`public function AsyncRequest()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructs a new asynchronous request.

Method Detail

hasPendingRequestForMessage | () | method

`override public function hasPendingRequestForMessage(msg:IMessage):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns `true` if there are any pending requests for the passed in message.

Parameters

| `msg:IMessage` — The message for which the existence of pending requests is checked.

Returns

| `Boolean` — Returns `true` if there are any pending requests for the passed in message; otherwise, returns `false`.

invoke | () | method |

`public function invoke(msg:IMessage, responder:IResponder):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatches the asynchronous request and stores the responder to call later.

Parameters

| `msg:IMessage` — The message to be sent asynchronously.
| `responder:IResponder` — The responder to be called later.

Sun Mar 5 2017, 03:42 PM +11:00