Packagemx.messaging.channels
Classpublic class NetConnectionChannel
InheritanceNetConnectionChannel Inheritance PollingChannel Inheritance Channel Inheritance flash.events.EventDispatcher
Subclasses AMFChannel

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

This NetConnectionChannel provides the basic NetConnection support for messaging. The AMFChannel and RTMPChannel both extend this class.


Public Properties
 PropertyDefined By
 Inheritedauthenticated : Boolean
[read-only] Indicates if this channel is authenticated.
Channel
 InheritedchannelSets : Array
[read-only] Provides access to the ChannelSets connected to the Channel.
Channel
 Inheritedconnected : Boolean
[read-only] Indicates whether this channel has established a connection to the remote destination.
Channel
 InheritedconnectTimeout : int
Provides access to the connect timeout in seconds for the channel.
Channel
 Inheritedendpoint : String
[read-only] Provides access to the endpoint for this channel.
Channel
 InheritedfailoverURIs : Array
Provides access to the set of endpoint URIs that this channel can attempt to failover to if the endpoint is clustered.
Channel
 Inheritedid : String
Provides access to the id of this channel.
Channel
  netConnection : NetConnection
[read-only] Provides access to the associated NetConnection for this Channel.
NetConnectionChannel
 Inheritedprotocol : String
[read-only] Provides access to the protocol that the channel uses.
Channel
 Inheritedreconnecting : Boolean
[read-only] Indicates whether this channel is in the process of reconnecting to an alternate endpoint.
Channel
 InheritedrecordMessageSizes : Boolean
[read-only] Channel property determines the level of performance information injection - whether we inject message sizes or not.
Channel
 InheritedrecordMessageTimes : Boolean
[read-only] Channel property determines the level of performance information injection - whether we inject timestamps or not.
Channel
 InheritedrequestTimeout : int
Provides access to the default request timeout in seconds for the channel.
Channel
 Inheriteduri : String
Provides access to the URI used to create the whole endpoint URI for this channel.
Channel
Protected Properties
 PropertyDefined By
 InheritedshouldBeConnected : Boolean
[read-only] Indicates whether this channel should be connected to its endpoint.
Channel
Public Methods
 MethodDefined By
  
NetConnectionChannel(id:String = null, uri:String = null)
Creates a new NetConnectionChannel instance.
NetConnectionChannel
 Inherited
applySettings(settings:XML):void
Subclasses should override this method to apply any settings that may be necessary for an individual channel.
Channel
 Inherited
connect(channelSet:ChannelSet):void
Connects the ChannelSet to the Channel.
Channel
 Inherited
disablePolling():void
Disables polling based on the number of times enablePolling() and disablePolling() have been invoked.
PollingChannel
 Inherited
disconnect(channelSet:ChannelSet):void
Disconnects the ChannelSet from the Channel.
Channel
 Inherited
enablePolling():void
Enables polling based on the number of times enablePolling() and disablePolling() have been invoked.
PollingChannel
 Inherited
logout(agent:MessageAgent):void
Sends a CommandMessage to the server to logout if the Channel is connected.
Channel
 Inherited
poll():void
Initiates a poll operation if there are consumers subscribed to this channel, and polling is enabled for this channel.
PollingChannel
 Inherited
send(agent:MessageAgent, message:IMessage):void
[override] Sends the specified message to its target destination.
PollingChannel
 Inherited
setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void
Sets the credentials to the specified value.
Channel
Protected Methods
 MethodDefined By
 Inherited
applyClientLoadBalancingSettings(props:XML):void
Applies the client load balancing urls if they exists.
Channel
 Inherited
connectFailed(event:ChannelFaultEvent):void
Processes a failed internal connect and dispatches the FAULT event for the channel.
Channel
 Inherited
connectSuccess():void
Processes a successful internal connect and dispatches the CONNECT event for the Channel.
Channel
 Inherited
connectTimeoutHandler(event:TimerEvent):void
Handles a connect timeout by dispatching a ChannelFaultEvent.
Channel
 Inherited
disconnectFailed(event:ChannelFaultEvent):void
Processes a failed internal disconnect and dispatches the FAULT event for the channel.
Channel
 Inherited
disconnectSuccess(rejected:Boolean = false):void
Processes a successful internal disconnect and dispatches the DISCONNECT event for the Channel.
Channel
 Inherited
flexClientWaitHandler(event:PropertyChangeEvent):void
Handles a change to the guard condition for managing initial Channel connect for the application.
Channel
 Inherited
getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder
Returns the appropriate MessageResponder for the Channel's send() method.
Channel
 Inherited
internalConnect():void
Connects the Channel to its endpoint.
Channel
 Inherited
internalDisconnect(rejected:Boolean = false):void
Disconnects the Channel from its endpoint.
Channel
 Inherited
internalSend(messageResponder:MessageResponder):void
Sends the Message out over the Channel and routes the response to the responder.
Channel
Events
 Event Summary Defined By
 Inherited
channelConnect
Dispatched after the channel has connected to its endpoint.Channel
 Inherited
channelDisconnect
Dispatched after the channel has disconnected from its endpoint.Channel
 Inherited
channelFault
Dispatched after the channel has faulted.Channel
 Inherited
message
Dispatched when a channel receives a message from its endpoint.Channel
 Inherited
propertyChange
Dispatched when a property of the channel changes.Channel
Protected Constants
 ConstantDefined By
 InheritedCONNECT_TIMEOUT_SECONDS : String = connect-timeout-seconds
[static]
Channel
 InheritedENABLE_SMALL_MESSAGES : String = enable-small-messages
[static]
Channel
 InheritedFALSE : String = false
[static]
Channel
 InheritedLOGIN_AFTER_DISCONNECT : String = login-after-disconnect
[static]
PollingChannel
 InheritedPIGGYBACKING_ENABLED : String = piggybacking-enabled
[static]
PollingChannel
 InheritedPOLLING_INTERVAL_LEGACY : String = polling-interval-seconds
[static]
PollingChannel
 InheritedPOLLING_INTERVAL_MILLIS : String = polling-interval-millis
[static]
PollingChannel
 InheritedRECORD_MESSAGE_SIZES : String = record-message-sizes
[static]
Channel
 InheritedRECORD_MESSAGE_TIMES : String = record-message-times
[static]
Channel
 InheritedREQUEST_TIMEOUT_SECONDS : String = request-timeout-seconds
[static]
Channel
 InheritedSERIALIZATION : String = serialization
[static]
Channel
 InheritedTRUE : String = true
[static]
Channel
Property Detail
netConnectionproperty
netConnection:NetConnection  [read-only]

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 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, LCDS 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.

Parameters
id:String (default = null) — The id of this Channel.
 
uri:String (default = null) — The uri for this Channel.



The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00