Flash Client 1.3

Class FlashTable

Object
   |
   +--FlashTable

class FlashTable


Represents a data table that can be fed with real-time data (delivered by Lightstreamer Server). It contains the subscription details and the event handlers needed to process the real-time data. When a FlashTable object is added to a JavaScriptBridge object, through the JavaScriptBridge.addTable() method, its state becomes "running". This means that the underlying LightstreamerClient activates a subscription to the required items through Lightstreamer Server and the data-table object begins to receive real-time events.
Defined in lsjavascriptbridge.as


Constructor Summary
FlashTable (<String> _group,<String> _schema,<String> _mode)
            Creates an object to be used to describe a data table.
 
Method Summary
 void onClearSnapshot(<Number> itemPos,<String> itemName)
           Event handler that is called by Lightstreamer each time a request to clear the snapshot pertaining to an item in the data table has been received from the Server.
 void onEndOfSnapshot(<Number> itemPos,<String> itemName)
           Event handler that is called by Lightstreamer to notify that all snapshot events for an item in the data table have been received, so that real time events are now going to be received.
 void onItemUpdate(<Number> itemPos,<FlashUpdateItemInfo> updateInfo,<String> itemName)
           Event handler that is called by Lightstreamer each time an update pertaining to an item in the data table has been received from the Server.
 void onLostUpdates(<Number> itemPos,<Number> lostUpdates,<String> itemName)
           Event handler that is called by Lightstreamer to notify that, due to internal resource limitations, Lightstreamer Server dropped one or more updates for an item in the data table.
 void onStart()
           Event handler that is called by Lightstreamer to notify that a data table has been successfully subscribed to through the Server.
 void setDataAdapter(<String> adapter)
           Setter method that sets the name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items in the Group.
 void setItemsRange(<Number> _start,<Number> _end)
           Setter method that sets a range of items within the specified group.
 void setRequestedBufferSize(<Number> buffSize)
           Setter method that sets the length to be requested to Lightstreamer Server for the internal queueing buffers for the items in the data table.
 void setRequestedMaxFrequency(<String> maxFreq)
           Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the data table.
 void setSelector(<String> selector)
           Setter method that sets the selector name for all the items in the data table.
 void setSnapshotRequired(<boolean> required)
           Setter method that enables/disables snapshot delivery request for the items in the data table.

Constructor Detail

FlashTable

FlashTable(<String> _group,<String> _schema,<String> _mode)

Method Detail

onClearSnapshot

void onClearSnapshot(<Number> itemPos,<String> itemName)

onEndOfSnapshot

void onEndOfSnapshot(<Number> itemPos,<String> itemName)

onItemUpdate

void onItemUpdate(<Number> itemPos,<FlashUpdateItemInfo> updateInfo,<String> itemName)

onLostUpdates

void onLostUpdates(<Number> itemPos,<Number> lostUpdates,<String> itemName)

onStart

void onStart()

setDataAdapter

void setDataAdapter(<String> adapter)

setItemsRange

void setItemsRange(<Number> _start,<Number> _end)

setRequestedBufferSize

void setRequestedBufferSize(<Number> buffSize)

setRequestedMaxFrequency

void setRequestedMaxFrequency(<String> maxFreq)

setSelector

void setSelector(<String> selector)

setSnapshotRequired

void setSnapshotRequired(<boolean> required)

Flash Client 1.3

Lightstreamer Flash Client
Documentation generated by JSDoc on Tue Apr 26 17:02:55 2016