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.
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.
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.
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).
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.
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.
|
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.
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.
|
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 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.
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.