Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The MessageResponder class handles a successful result or fault from a message
destination. For each message that a Channel sends, the Channel creates a
MessageResponder to handle the result. Upon a response, the Channel will
invoke either the
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.
agent:MessageAgent
[read-only]
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the MessageAgent that sent the message.
Implementation public function get agent():MessageAgent
channel:Channel
[read-only]
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the Channel used to send the message.
Implementation public function get channel():Channel
message:IMessage
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the sent Message.
Implementation public function get message():IMessage
public function set message(value:IMessage):void
public function MessageResponder(agent:MessageAgent, message:IMessage, channel:Channel = null)
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs a MessageResponder to handle the response for the specified
Message for the specified MessageAgent.
Parameters | agent:MessageAgent — The MessageAgent sending the Message.
|
|
| message:IMessage — The Message being sent.
|
|
| channel:Channel (default = null ) — The Channel used to send.
|
protected function createRequestTimeoutErrorMessage():ErrorMessage
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an ErrorMessage that can be passed to the associated
MessageAgent's callbacks upon a request timeout.
Returns | ErrorMessage — Returns an ErrorMessage that can be passed to the associated
MessageAgent's callbacks upon a request timeout.
|
protected function requestTimedOut():void
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Subclasses must override this method to handle a request timeout and
invoke the proper callbacks on the associated MessageAgent.
public final function result(message:IMessage):void
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
protected function resultHandler(message:IMessage):void
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
public final function status(message:IMessage):void
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
protected function statusHandler(message:IMessage):void
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|