Package | mx.messaging.channels |
Class | public class AMFChannel |
Inheritance | AMFChannel NetConnectionChannel PollingChannel Channel EventDispatcher Object |
Subclasses | SecureAMFChannel, StreamingAMFChannel |
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The AMFChannel relies on network services native to Flash Player and AIR, and exposed to ActionScript by the NetConnection class. This channel uses NetConnection exclusively, and creates a new NetConnection per instance.
Channels are created within the framework using the
ServerConfig.getChannel()
method. Channels can be constructed
directly and assigned to a ChannelSet if desired.
Channels represent a physical connection to a remote endpoint. Channels are shared across destinations by default. This means that a client targetting different destinations may use the same Channel to communicate with these destinations.
When used in polling mode, this Channel polls the server for new messages
based on the polling-interval-seconds
property in the configuration file,
and this can be changed by setting the pollingInterval
property.
The default value is 3 seconds.
To enable polling, the channel must be connected and the polling-enabled
property in the configuration file must be set to true
, or the
pollingEnabled
property of the Channel must be set to true
.
Property | Defined By | ||
---|---|---|---|
authenticated : Boolean [read-only]
Indicates if this channel is authenticated. | Channel | ||
channelSets : Array [read-only]
Provides access to the ChannelSets connected to the Channel. | Channel | ||
connected : Boolean [read-only]
Indicates whether this channel has established a connection to the
remote destination. | Channel | ||
connectTimeout : int
Provides access to the connect timeout in seconds for the channel. | Channel | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
endpoint : String [read-only]
Provides access to the endpoint for this channel. | Channel | ||
failoverURIs : Array
Provides access to the set of endpoint URIs that this channel can
attempt to failover to if the endpoint is clustered. | Channel | ||
id : String
Provides access to the id of this channel. | Channel | ||
netConnection : NetConnection [read-only]
Provides access to the associated NetConnection for this Channel. | NetConnectionChannel | ||
piggybackingEnabled : Boolean
Indicates whether this channel will piggyback poll requests along
with regular outbound messages when an outstanding poll is not in
progress. | AMFChannel | ||
polling : Boolean [read-only]
Reports whether the channel is actively polling. | AMFChannel | ||
pollingEnabled : Boolean
Indicates whether this channel is enabled to poll. | AMFChannel | ||
pollingInterval : Number
Provides access to the polling interval for this Channel. | AMFChannel | ||
protocol : String [override] [read-only]
Returns the protocol for this channel (http). | AMFChannel | ||
reconnecting : Boolean [read-only]
Indicates whether this channel is in the process of reconnecting to an
alternate endpoint. | Channel | ||
recordMessageSizes : Boolean [read-only]
Channel property determines the level of performance information injection - whether
we inject message sizes or not. | Channel | ||
recordMessageTimes : Boolean [read-only]
Channel property determines the level of performance information injection - whether
we inject timestamps or not. | Channel | ||
requestTimeout : int
Provides access to the default request timeout in seconds for the
channel. | Channel | ||
uri : String
Provides access to the URI used to create the whole endpoint URI for this channel. | Channel |
Method | Defined By | ||
---|---|---|---|
Constructor. | AMFChannel | ||
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 | ||
Subclasses should override this method to apply any settings that may be
necessary for an individual channel. | Channel | ||
Connects the ChannelSet to the Channel. | Channel | ||
Disables polling based on the number of times enablePolling()
and disablePolling() have been invoked. | PollingChannel | ||
Disconnects the ChannelSet from the Channel. | Channel | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Enables polling based on the number of times enablePolling()
and disablePolling() have been invoked. | PollingChannel | ||
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 | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Sends a CommandMessage to the server to logout if the Channel is connected. | Channel | ||
Initiates a poll operation if there are consumers subscribed to this channel,
and polling is enabled for this channel. | PollingChannel | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
[override]
Sends the specified message to its target destination. | PollingChannel | ||
Sets the credentials to the specified value. | Channel | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
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 |
piggybackingEnabled | property |
piggybackingEnabled:Boolean
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether this channel will piggyback poll requests along with regular outbound messages when an outstanding poll is not in progress. This allows the server to piggyback data for the client along with its response to client's message.
Implementation
public function get piggybackingEnabled():Boolean
public function set piggybackingEnabled(value:Boolean):void
polling | property |
pollingEnabled | property |
pollingEnabled:Boolean
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether this channel is enabled to poll.
Implementation
public function get pollingEnabled():Boolean
public function set pollingEnabled(value:Boolean):void
pollingInterval | property |
pollingInterval:Number
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the polling interval for this Channel. The value is in milliseconds. This value determines how often this Channel requests messages from the server, to approximate server push.
Implementation
public function get pollingInterval():Number
public function set pollingInterval(value:Number):void
Throws
ArgumentError — If the pollingInterval is assigned a value of 0 or
less.
|
protocol | property |
protocol:String
[read-only] [override] Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the protocol for this channel (http).
Implementation
override public function get protocol():String
AMFChannel | () | Constructor |
public function AMFChannel(id:String = null, uri:String = null)
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parametersid:String (default = null ) — The id of this Channel.
| |
uri:String (default = null ) — The uri for this Channel.
|
Thu Dec 6 2018, 01:12 PM -08:00