Packagemx.messaging.channels
Classpublic class StreamingConnectionHandler
InheritanceStreamingConnectionHandler Inheritance flash.events.EventDispatcher

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


Protected Properties
 PropertyDefined 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
 MethodDefined By
  
StreamingConnectionHandler(channel:Channel, log:ILogger)
Constructor.
StreamingConnectionHandler
  
closeStreamingConnection():void
Used by the streaming channels to shut down the streaming connection.
StreamingConnectionHandler
  
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
Protected Methods
 MethodDefined By
  
readMessage():IMessage
Used by the streamProgressHandler to read a message.
StreamingConnectionHandler
Events
 Event Summary Defined By
  
status
Dispatched when the StreamingConnectionHandler receives a status command from the server.StreamingConnectionHandler
Public Constants
 ConstantDefined 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
channelproperty
protected var channel:Channel

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

The Channel that uses this class.

chunkBufferproperty 
protected var chunkBuffer:ByteArray

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

dataBytesToReadproperty 
protected var dataBytesToRead:int = -1

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

dataOffsetproperty 
protected var dataOffset:int

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 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, LCDS 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, LCDS 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, LCDS 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, LCDS 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
StatusEvent.type property = flash.events.StatusEvent

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

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

Constant Detail
DISCONNECT_CODEConstant
public static const DISCONNECT_CODE:String = disconnect

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




The Apache Software Foundation

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