Package | mx.messaging.channels |
Class | public class NetConnectionChannel |
Inheritance | NetConnectionChannel PollingChannel Channel EventDispatcher Object |
Subclasses | AMFChannel, RTMPChannel |
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 |
Public Properties
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 | ||
protocol : String [read-only]
Provides access to the protocol that the channel uses. | Channel | ||
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 |
Protected Properties
Public Methods
Method | Defined By | ||
---|---|---|---|
Creates a new NetConnectionChannel instance. | NetConnectionChannel | ||
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 |
Protected Methods
Protected Constants
Property Detail
netConnection | property |
netConnection:NetConnection
[read-only] 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 associated NetConnection for this Channel.
Implementation
public function get netConnection():NetConnection
Constructor Detail
NetConnectionChannel | () | Constructor |
public function NetConnectionChannel(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 |
Creates a new NetConnectionChannel instance.
The underlying NetConnection's objectEncoding
is set to ObjectEncoding.AMF3
by default. It can be
changed manually by accessing the channel's netConnection
property. The global NetConnection.defaultObjectEncoding
setting is not honored by this channel.
id: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