Packagemx.messaging.channels
Classpublic class StreamingAMFChannel
InheritanceStreamingAMFChannel Inheritance AMFChannel Inheritance NetConnectionChannel Inheritance PollingChannel Inheritance Channel Inheritance flash.events.EventDispatcher
Subclasses SecureStreamingAMFChannel

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

The StreamingAMFChannel class provides support for messaging and offers a different push model than the base AMFChannel. Rather than polling for data from the server, the streaming channel opens an internal HTTP connection to the server that is held open to allow the server to stream data down to the client with no poll overhead.

Messages sent by this channel to the server are sent using a NetConnection which uses an HTTP connection internally for the duration of the operation. Once the message is sent and an acknowledgement or fault is returned the HTTP connection used by NetConnection is released by the channel. These client-to-server messages are not sent over the streaming HTTP connection that the channel holds open to receive server pushed data.

Although this class extends the base AMFChannel to inherit the regular AMF handling, it does not support polling.



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
 InheritednetConnection : NetConnection
[read-only] Provides access to the associated NetConnection for this Channel.
NetConnectionChannel
 InheritedpiggybackingEnabled : Boolean
Indicates whether this channel will piggyback poll requests along with regular outbound messages when an outstanding poll is not in progress.
AMFChannel
 Inheritedpolling : Boolean
[read-only] Reports whether the channel is actively polling.
AMFChannel
 InheritedpollingEnabled : Boolean
Indicates whether this channel is enabled to poll.
AMFChannel
 InheritedpollingInterval : Number
Provides access to the polling interval for this Channel.
AMFChannel
 Inheritedprotocol : String
[override] [read-only] Returns the protocol for this channel (http).
AMFChannel
 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
  
StreamingAMFChannel(id:String = null, uri:String = null)
Constructor.
StreamingAMFChannel
 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
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
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
  
poll():void
[override] Polling is not supported by this channel.
StreamingAMFChannel
 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
Applies the client load balancing urls if they exists.
Channel
 Inherited
Processes a failed internal connect and dispatches the FAULT event for the channel.
Channel
 Inherited
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
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
Handles a change to the guard condition for managing initial Channel connect for the application.
Channel
 Inherited
Returns the appropriate MessageResponder for the Channel's send() method.
Channel
 Inherited
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
 InheritedDispatched after the channel has connected to its endpoint.Channel
 InheritedDispatched after the channel has disconnected from its endpoint.Channel
 InheritedDispatched after the channel has faulted.Channel
 InheritedDispatched when a channel receives a message from its endpoint.Channel
 InheritedDispatched 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
Constructor Detail
StreamingAMFChannel()Constructor
public function StreamingAMFChannel(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

Constructor.

Parameters
id:String (default = null) — The id of this Channel.
 
uri:String (default = null) — The uri for this Channel.
Method Detail
poll()method
override public function poll():void

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

Polling is not supported by this channel.