| Package | mx.messaging |
| Class | public class MessageResponder |
| Inheritance | MessageResponder  Responder Object |
result() or status() callback
on the MessageResponder. MessageResponder subclasses should override these
methods to perform any necessary processing. For every response, whether a
successful result or an error, the MessageResponder should invoke
acknowledge() on its agent. If the response was a fault, the
MessageResponder should also invoke fault() on its agent.
| Property | Defined By | ||
|---|---|---|---|
| agent : MessageAgent
[read-only]
Provides access to the MessageAgent that sent the message.
| MessageResponder | ||
| channel : Channel
[read-only]
Provides access to the Channel used to send the message.
| MessageResponder | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| message : IMessage
Provides access to the sent Message.
| MessageResponder | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| Method | Defined By | ||
|---|---|---|---|
|
Constructs a MessageResponder to handle the response for the specified
Message for the specified MessageAgent.
| MessageResponder | ||
|
Indicates whether an object has a specified property defined.
| Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Called by the channel that created this MessageResponder when a
response returns from the destination.
| MessageResponder | ||
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Called by the channel that created this MessageResponder when a fault
response returns from the destination.
| MessageResponder | ||
|
Returns the string representation of the specified object.
| Object | |
|
Returns the primitive value of the specified object.
| Object | |
| Method | Defined By | ||
|---|---|---|---|
|
Constructs an ErrorMessage that can be passed to the associated
MessageAgent's callbacks upon a request timeout.
| MessageResponder | ||
|
Subclasses must override this method to handle a request timeout and
invoke the proper callbacks on the associated MessageAgent.
| MessageResponder | ||
|
Subclasses must override this method to perform custom processing of
the result and invoke the proper callbacks on the associated
MessageAgent.
| MessageResponder | ||
|
Subclasses must override this method to perform custom processing of
the status and invoke the proper callbacks on the associated
MessageAgent.
| MessageResponder | ||
| agent | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesagent:MessageAgent [read-only] Provides access to the MessageAgent that sent the message.
public function get agent():MessageAgent
| channel | property |
channel:Channel [read-only] Provides access to the Channel used to send the message.
public function get channel():Channel
| message | property |
message:IMessage [read-write] Provides access to the sent Message.
public function get message():IMessage
public function set message(value:IMessage):void
| MessageResponder | () | Constructor |
public function MessageResponder(agent:MessageAgent, message:IMessage, channel:Channel = null)
Constructs a MessageResponder to handle the response for the specified Message for the specified MessageAgent.
Parametersagent:MessageAgent — agent The MessageAgent sending the Message.
|
|
message:IMessage — message The Message being sent.
|
|
channel:Channel (default = null) |
| createRequestTimeoutErrorMessage | () | method |
protected function createRequestTimeoutErrorMessage():ErrorMessage
Constructs an ErrorMessage that can be passed to the associated MessageAgent's callbacks upon a request timeout.
ReturnsErrorMessage |
| requestTimedOut | () | method |
protected function requestTimedOut():void
Subclasses must override this method to handle a request timeout and invoke the proper callbacks on the associated MessageAgent.
| result | () | method |
public final function result(message:IMessage):void
Called by the channel that created this MessageResponder when a
response returns from the destination.
This method performs core result processing and then invokes the
resultHandler() method that subclasses may override to
perform any necessary custom processing.
Parameters
message:IMessage — The result Message returned by the destination.
|
| resultHandler | () | method |
protected function resultHandler(message:IMessage):void
Subclasses must override this method to perform custom processing of the result and invoke the proper callbacks on the associated MessageAgent.
Parameters
message:IMessage — The result Message returned by the destination.
|
| status | () | method |
public final function status(message:IMessage):void
Called by the channel that created this MessageResponder when a fault
response returns from the destination.
This method performs core result processing and then invokes the
statusHandler() method that subclasses may override to
perform any necessary custom processing.
Parameters
message:IMessage — The fault Message returned by the destination.
|
| statusHandler | () | method |
protected function statusHandler(message:IMessage):void
Subclasses must override this method to perform custom processing of the status and invoke the proper callbacks on the associated MessageAgent.
Parameters
message:IMessage — The fault Message returned by the destination.
|