class MessageAgent
package feathers.messaging
extends EventDispatcher
extended by AbstractConsumer, AbstractProducer
Constructor
Variables
read onlyauthenticated:Bool
Indicates if this MessageAgent is using an authenticated connection to its destination.
channelSet:ChannelSet
Provides access to the ChannelSet used by the MessageAgent. The ChannelSet can be manually constructed and assigned, or it will be dynamically initialized to use the configured Channels for the destination for this MessageAgent.
read onlyclientId:String
Provides access to the client id for the MessageAgent. MessageAgents are assigned their client id by the remote destination and this value is used to route messages from the remote destination to the proper MessageAgent.
read onlyconnected:Bool
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet. The propertyChange event is dispatched when
this property changes.
destination:String
Provides access to the destination for the MessageAgent. Changing the destination will disconnect the MessageAgent if it is currently connected.
Throws:
mx.messaging.errors.InvalidDestinationError | If the destination is null or zero-length. |
|---|
requestTimeout:Int
Provides access to the request timeout in seconds for sent messages. If an acknowledgement, response or fault is not received from the remote destination before the timeout is reached the message is faulted on the client. A value less than or equal to zero prevents request timeout.
Methods
acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):Void
Invoked by a MessageResponder upon receiving a result for a sent
message. Subclasses may override this method if they need to perform
custom acknowledgement processing, but must invoke
super.acknowledge() as well. This method dispatches a
MessageAckEvent.
Parameters:
ackMsg | The AcknowledgMessage returned. |
|---|---|
msg | The original sent message. |
channelConnectHandler(event:ChannelEvent):Void
Handles a CONNECT ChannelEvent. Subclasses that need to perform custom
processing should override this method, and invoke
super.channelConnectHandler().
Parameters:
event | The ChannelEvent. |
|---|
channelDisconnectHandler(event:ChannelEvent):Void
Handles a DISCONNECT ChannelEvent. Subclasses that need to perform
custom processing should override this method, and invoke
super.channelDisconnectHandler().
Parameters:
event | The ChannelEvent. |
|---|
channelFaultHandler(event:ChannelFaultEvent):Void
Handles a ChannelFaultEvent. Subclasses that need to perform custom
processing should override this method, and invoke
super.channelFaultHandler().
Parameters:
The | ChannelFaultEvent |
|---|
disconnect():Void
Disconnects the MessageAgent's network connection. This method does not wait for outstanding network operations to complete.
fault(errMsg:ErrorMessage, msg:IMessage):Void
Invoked by a MessageResponder upon receiving a fault for a sent message.
Subclasses may override this method if they need to perform custom fault
processing, but must invoke super.fault() as well. This
method dispatchs a MessageFaultEvent.
Parameters:
errMsg | The ErrorMessage. |
|---|---|
msg | The original sent message that caused this fault. |
hasPendingRequestForMessage(msg:IMessage):Bool
Returns true if there are any pending requests for the passed in message. This method should be overriden by subclasses
Parameters:
msg | The message for which the existence of pending requests is checked. |
|---|
Returns:
Returns true if there are any pending requests for the
passed in message.
initialized(document:Any, id:String):Void
Called after the implementing object has been created and all properties specified on the tag have been assigned.
Parameters:
document | MXML document that created this object. |
|---|---|
id | id used by the document to refer to this object. If the object is a deep property on the document, id is null. |
logout():Void
Logs the MessageAgent out from its remote destination.
Logging out of a destination applies to everything connected using the same ChannelSet
as specified in the server configuration. For example, if several DataService components
are connected over an RTMP channel and logout() is invoked on one of them,
all other client components that are connected using the same ChannelSet are also logged out.
Note: Adobe recommends that you use the mx.messaging.ChannelSet.logout() method rather than this method.
See also:
mx.messaging.ChannelSet#logout()
setCredentials(username:String, password:String, ?charset:String):Void
Sets the credentials that the MessageAgent uses to authenticate to destinations. The credentials are applied to all services connected over the same ChannelSet.
Parameters:
username | The username. |
|---|---|
password | The password. |
charset | The character set encoding to use while encoding the credentials. The default is null, which implies the legacy charset of ISO-Latin-1. The only other supported charset is "UTF-8". |
Throws:
flash.errors.IllegalOperationError | in two situations; if credentials have already been set and an authentication is in progress with the remote detination, or if authenticated and the credentials specified don't match the currently authenticated credentials. |
|---|
setRemoteCredentials(username:String, password:String, ?charset:String):Void
Sets the remote credentials that will be passed through to the remote destination for authenticating to secondary systems.
Parameters:
username | The username. |
|---|---|
password | The password. |
charset | The character set encoding to use while encoding the remote credentials. The default is null, which implies the legacy charset of ISO-Latin-1. The only other currently supported option is "UTF-8". |