mx.messaging.channels.StreamingConnectionHandler - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.messaging.channels
Class	public class StreamingConnectionHandler
Inheritance	StreamingConnectionHandler EventDispatcher Object

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

A helper class that is used by the streaming channels to open 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.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Protected Properties

	Property		Defined By
		channel : Channel The Channel that uses this class.	StreamingConnectionHandler
		chunkBuffer : ByteArray Byte buffer used to store the current chunk from the remote endpoint.	StreamingConnectionHandler
		dataBytesToRead : int = -1 Counter that keeps track of how many data bytes remain to be read for the current chunk.	StreamingConnectionHandler
		dataOffset : int Index into the chunk buffer pointing to the first byte of chunk data.	StreamingConnectionHandler

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StreamingConnectionHandler(channel:Channel, log:ILogger) Constructor.	StreamingConnectionHandler
		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
		closeStreamingConnection():void Used by the streaming channels to shut down the streaming connection.	StreamingConnectionHandler
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		openStreamingConnection(appendToURL:String = null):void Used by the streaming channels to set up the streaming connection if necessary and issue the open request to the server.	StreamingConnectionHandler
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

	Method		Defined By
		readMessage():IMessage Used by the streamProgressHandler to read a message.	StreamingConnectionHandler

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
status	Dispatched when the StreamingConnectionHandler receives a status command from the server.	StreamingConnectionHandler

Public Constants

	Constant		Defined By
		DISCONNECT_CODE : String = "disconnect" [static] The code for the StatusEvent dispatched by this handler when a disconnect command is received from the server.	StreamingConnectionHandler

Property Detail

channel

property

protected var channel:Channel

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

The Channel that uses this class.

chunkBuffer

property

protected var chunkBuffer:ByteArray

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Byte buffer used to store the current chunk from the remote endpoint. Once a full chunk has been buffered, a message instance encoded in binary AMF format can be read from the chunk and dispatched.

dataBytesToRead

property

protected var dataBytesToRead:int = -1

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Counter that keeps track of how many data bytes remain to be read for the current chunk. A sentinal value of -1 indicates an initial state (either waiting for the first chunk or just finished parsing the previous chunk).

dataOffset

property

protected var dataOffset:int

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Index into the chunk buffer pointing to the first byte of chunk data.

Constructor Detail

StreamingConnectionHandler

()

Constructor

public function StreamingConnectionHandler(channel:Channel, log:ILogger)

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`channel:Channel` — The Channel that uses this class.

	`log:ILogger` — Reference to the logger for the associated Channel.

Method Detail

closeStreamingConnection

()

method

public function closeStreamingConnection():void

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Used by the streaming channels to shut down the streaming connection.

openStreamingConnection

()

method

public function openStreamingConnection(appendToURL:String = null):void

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Used by the streaming channels to set up the streaming connection if necessary and issue the open request to the server.

Parameters

appendToURL:String (default = null) — The string to append such as session id to the endpoint url while making the streaming connection request.

readMessage

()

method

protected function readMessage():IMessage

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Used by the streamProgressHandler to read a message. Default implementation returns null and subclasses must override this method.

Returns

IMessage — Returns the message that was read.

Event Detail

status

Event

Event Object Type: flash.events.StatusEvent
property StatusEvent.type = flash.events.StatusEvent

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatched when the StreamingConnectionHandler receives a status command from the server.

Constant Detail

DISCONNECT_CODE

Constant

public static const DISCONNECT_CODE:String = "disconnect"

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

The code for the StatusEvent dispatched by this handler when a disconnect command is received from the server.