Package | mx.messaging.channels |
Class | public class PollingChannel |
Inheritance | PollingChannel Channel EventDispatcher Object |
Subclasses | HTTPChannel, NetConnectionChannel |
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 |
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 | ||
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 |
Property | Defined By | ||
---|---|---|---|
shouldBeConnected : Boolean [read-only]
Indicates whether this channel should be connected to its endpoint. | Channel |
Method | Defined By | ||
---|---|---|---|
Creates a new PollingChannel instance with the specified id. | PollingChannel | ||
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 |
Method | Defined By | ||
---|---|---|---|
Applies the client load balancing urls if they exists. | Channel | ||
Processes a failed internal connect and dispatches the
FAULT event for the channel. | Channel | ||
Processes a successful internal connect and dispatches the
CONNECT event for the Channel. | Channel | ||
Handles a connect timeout by dispatching a ChannelFaultEvent. | Channel | ||
Processes a failed internal disconnect and dispatches the
FAULT event for the channel. | Channel | ||
Processes a successful internal disconnect and dispatches the
DISCONNECT event for the Channel. | Channel | ||
Handles a change to the guard condition for managing initial Channel connect for the application. | Channel | ||
Returns the appropriate MessageResponder for the Channel's
send() method. | Channel | ||
Connects the Channel to its endpoint. | Channel | ||
Disconnects the Channel from its endpoint. | Channel | ||
Sends the Message out over the Channel and routes the response to the
responder. | Channel |
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
Dispatched after the channel has connected to its endpoint. | Channel | |||
Dispatched after the channel has disconnected from its endpoint. | Channel | |||
Dispatched after the channel has faulted. | Channel | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched when a channel receives a message from its endpoint. | Channel | |||
Dispatched when a property of the channel changes. | Channel |
Constant | Defined By | ||
---|---|---|---|
LOGIN_AFTER_DISCONNECT : String = "login-after-disconnect" [static] | PollingChannel | ||
PIGGYBACKING_ENABLED : String = "piggybacking-enabled" [static] | PollingChannel | ||
POLLING_INTERVAL_LEGACY : String = "polling-interval-seconds" [static] | PollingChannel | ||
POLLING_INTERVAL_MILLIS : String = "polling-interval-millis" [static] | PollingChannel |
PollingChannel | () | Constructor |
public function PollingChannel(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 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.
Parametersid:String (default = null ) — The id of this Channel.
| |
uri:String (default = null ) — The uri for this Channel.
|
disablePolling | () | method |
public function disablePolling():void
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 |
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, Adobe Digital Enterprise Platform Data Services for Java EE 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, Adobe Digital Enterprise Platform Data Services for Java EE 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, Adobe Digital Enterprise Platform Data Services for Java EE 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.
|
LOGIN_AFTER_DISCONNECT | Constant |
protected static const LOGIN_AFTER_DISCONNECT:String = "login-after-disconnect"
PIGGYBACKING_ENABLED | Constant |
protected static const PIGGYBACKING_ENABLED:String = "piggybacking-enabled"
POLLING_INTERVAL_LEGACY | Constant |
protected static const POLLING_INTERVAL_LEGACY:String = "polling-interval-seconds"
POLLING_INTERVAL_MILLIS | Constant |
protected static const POLLING_INTERVAL_MILLIS:String = "polling-interval-millis"
Thu Dec 4 2014, 05:50 PM -08:00