Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.messaging.channels 
PollingChannel 
Packagemx.messaging.channels
Classpublic class PollingChannel
InheritancePollingChannel Inheritance Channel Inheritance EventDispatcher Inheritance Object
Subclasses HTTPChannel, NetConnectionChannel

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

The PollingChannel class provides the polling behavior that all polling channels in the messaging system require.



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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 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
 Inheritedprotocol : String
[read-only] Provides access to the protocol that the channel uses.
Channel
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
  
PollingChannel(id:String = null, uri:String = null)
Creates a new PollingChannel instance with the specified id.
PollingChannel
 Inherited
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
 Inherited
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
  
Disables polling based on the number of times enablePolling() and disablePolling() have been invoked.
PollingChannel
 Inherited
Disconnects the ChannelSet from the Channel.
Channel
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
Enables polling based on the number of times enablePolling() and disablePolling() have been invoked.
PollingChannel
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
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
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
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
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
Sends the Message out over the Channel and routes the response to the responder.
Channel
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 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
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a channel receives a message from its endpoint.Channel
 InheritedDispatched when a property of the channel changes.Channel
Constructor Detail

PollingChannel

()Constructor
public function PollingChannel(id:String = null, uri:String = null)

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

Creates a new PollingChannel instance with the specified id. Once a PollingChannel is connected and begins polling, it will issue a poll request once every three seconds by default.

Note: The PollingChannel type should not be constructed directly. Instead create instances of protocol specific subclasses such as HTTPChannel or AMFChannel that extend it.

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

disablePolling

()method
public function disablePolling():void

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

Disables polling based on the number of times enablePolling() and disablePolling() have been invoked. If the net result is to disable polling the channel stops polling.

Invoked automatically based upon subscribing or unsubscribing from a remote destination over a PollingChannel.

enablePolling

()method 
public function enablePolling():void

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

Enables polling based on the number of times enablePolling() and disablePolling() have been invoked. If the net result is to enable polling the channel will poll the server on behalf of connected MessageAgents.

Invoked automatically based upon subscribing or unsubscribing from a remote destination over a PollingChannel.

poll

()method 
public function poll():void

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

Initiates a poll operation if there are consumers subscribed to this channel, and polling is enabled for this channel. Note that this method will not start a new poll if one is currently in progress.

send

()method 
override public function send(agent:MessageAgent, message:IMessage):void

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

Sends the specified message to its target destination. Subclasses must override the internalSend() method to perform the actual send. PollingChannel will wrap outbound messages in poll requests if a poll is not currently outstanding.

Parameters

agent:MessageAgent — The MessageAgent that is sending the message.
 
message:IMessage — The Message to send.


Throws
InvalidDestinationError — If neither the MessageAgent nor the message specify a destination.