|
Flash Client 1.3 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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(<String> _group,<String> _schema,<String> _mode)
_group
- a String group identifier, which identifies the items that provide values for the data table rows. _schema
- a String schema identifier, which identifies the fields that represent the data table columns. _mode
- the subscription mode for the items, required by Lightstreamer Server. Permitted values are: Method Detail |
void onClearSnapshot(<Number> itemPos,<String> itemName)
itemPos
- 1-based index of the item within the group.
itemName
- name of the item or null, depending on the way the group was identified in the FlashTable constructor. In case an Array of item names was supplied, the name is available; otherwise null is passed.
void onEndOfSnapshot(<Number> itemPos,<String> itemName)
itemPos
- 1-based index of the item within the group.
itemName
- name of the item or null, depending on the way the group was identified in the FlashTable constructor. In case an Array of item names was supplied, the name is available; otherwise null is passed.
void onItemUpdate(<Number> itemPos,<FlashUpdateItemInfo> updateInfo,<String> itemName)
itemPos
- 1-based index of the item within the group.
updateInfo
- a value object containinig the updated values for all the fields, together with the old values for the fields.
itemName
- name of the item or null, depending on the way the group was identified in the FlashTable constructor. In case an Array of item names was supplied, the name is available; otherwise null is passed.
void onLostUpdates(<Number> itemPos,<Number> lostUpdates,<String> itemName)
itemPos
- 1-based index of the item within the group.
lostUpdates
- The number of consecutive updates dropped for the item.
itemName
- name of the item or null, depending on the way the group was identified in the FlashTable constructor. In case an Array of item names was supplied, the name is available; otherwise null is passed.
void onStart()
void setDataAdapter(<String> adapter)
adapter
- the name of the Data Adapter. A null value is equivalent to the "DEFAULT" name.
void setItemsRange(<Number> _start,<Number> _end)
_start
- 1-based index of the first item in the group that has to be subscribed.
_end
- 1-based index of the last item in the group that has to be subscribed.
void setRequestedBufferSize(<Number> buffSize)
buffSize
- The length of the internal queueing buffers to be used in the Server. If a 0 value or the string "unlimited" is supplied, then the buffer length is decided by the Server.
void setRequestedMaxFrequency(<String> maxFreq)
maxFreq
- The maximum update frequency (expressed in updates per second) for each item in the data table. If a 0 value or the string "unlimited" is supplied, then the maximum frequency is decided by the Server. It is also possible to supply the string "unfiltered", to ask for unfiltered dispatching, if it is allowed for the items.
void setSelector(<String> selector)
selector
- name of a selector, to be recognized by the Metadata Adapter, or null to unset the selector.
void setSnapshotRequired(<boolean> required)
required
- true/false to request/not request snapshot delivery. If the subscription mode is DISTINCT, instead of true, it is also possible to supply a number, to specify the requested length of the snapshot (though the length of the received snapshot may be less than requested, because of insufficient data or server side limits); passing true means that the snapshot length should be determined only by the Server.
|
Flash Client 1.3 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |