Package | mx.rpc |
Class | public class AsyncRequest |
Inheritance | AsyncRequest Producer AbstractProducer MessageAgent EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
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
Method | Defined By | ||
---|---|---|---|
Constructs a new asynchronous request. | AsyncRequest | ||
Invoked by a MessageResponder upon receiving a result for a sent
message. | MessageAgent | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Handles a CONNECT ChannelEvent. | MessageAgent | ||
Handles a DISCONNECT ChannelEvent. | MessageAgent | ||
Handles a ChannelFaultEvent. | MessageAgent | ||
Connects the Producer to its target destination. | AbstractProducer | ||
[override]
Disconnects the Producer from its remote destination. | AbstractProducer | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
[override]
Returns true if there are any pending requests for the passed in message. | AsyncRequest | ||
Called after the implementing object has been created
and all properties specified on the tag have been assigned. | MessageAgent | ||
Dispatches the asynchronous request and stores the responder to call
later. | AsyncRequest | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Logs the MessageAgent out from its remote destination. | MessageAgent | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Sends the specified message to its destination. | AbstractProducer | ||
Sets the credentials that the MessageAgent uses to authenticate to
destinations. | MessageAgent | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Sets the remote credentials that will be passed through to the remote destination
for authenticating to secondary systems. | MessageAgent | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Protected Methods
Method | Defined By | ||
---|---|---|---|
Handles the authentication fault on the server. | MessageAgent | ||
Used to automatically initialize the channelSet property for the
MessageAgent before it connects for the first time. | MessageAgent | ||
Sends a Message from the MessageAgent to its destination using the
agent's ChannelSet. | MessageAgent | ||
This function should be overriden by sublasses to implement reauthentication due to
server session time-out behavior specific to them. | MessageAgent |
Events
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when an acknowledge message is received for a sent message. | MessageAgent | |||
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
Dispatched when the underlying Channel the MessageAgent is using connects. | MessageAgent | |||
Dispatched when the underlying Channel the MessageAgent is using disconnects. | MessageAgent | |||
Dispatched when the underlying Channel the MessageAgent is using faults. | MessageAgent | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched when a message fault occurs. | MessageAgent | |||
Dispatched when the connected property of the MessageAgent changes. | MessageAgent |
Public Constants
Constant | Defined By |
---|
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.
|
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.
|
Thu Dec 4 2014, 05:50 PM -08:00