LSTableInfo Class Reference

The LSTableInfo class contains the specification of a table to be subscribed to Lightstreamer Server. More...

#import <LSTableInfo.h>

Inheritance diagram for LSTableInfo:

List of all members.

Static Public Member Functions
(LSTableInfo *)	+ tableInfoWithGroup:mode:schema:dataAdapter:snapshot:
	Creates and returns an LSTableInfo object with the specified parameters.
Protected Attributes
NSString *	_group
NSString *	_schema
Properties
NSString *	group
	The name of the Group of items contained in this table.
LSMode	mode
	The subscription mode for the items contained in this table.
NSString *	schema
	The name of the Schema of fields used in this table.
NSString *	dataAdapter
	The name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items in the Group.
NSString *	selector
	The selector to be applied by the Server to the updates.
BOOL	snapshot
	Whether or not the snapshot is being asked for the items contained in this table.
int	start
	The position of the first item in the Group to be considered.
int	end
	the position of the last item in the Group to be considered.
int	requestedDistinctSnapshotLength
	The requested length for the snapshot to be received for all the items in the table.
int	requestedBufferSize
	the requested size for the Server ItemEventBuffer for all the items in the table.
double	requestedMaxFrequency
	The maximum update frequency for all the items in the table.
BOOL	unfilteredDispatch
	Events for the items in the table are dispatched in an unfiltered way.

---

Detailed Description

The LSTableInfo class contains the specification of a table to be subscribed to Lightstreamer Server.

---

Member Function Documentation

+ (LSTableInfo *) tableInfoWithGroup:		(NSString *)	group
mode:		(LSMode)	mode
schema:		(NSString *)	schema
dataAdapter:		(NSString *)	dataAdapter
snapshot:		(BOOL)	snapshot

Creates and returns an LSTableInfo object with the specified parameters.

Parameters:

group	The name of the Group of items contained in this table.
mode	The subscription mode for the items contained in this table.
schema	The name of the Schema of fields used in this table.
dataAdapter	The name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items in the Group. If it is nil, the "DEFAULT" name is used.
snapshot	Whether or not the snapshot is being asked for the items contained in this table.

Returns:

The LSTableInfo object.

---

Member Data Documentation

- (NSString*) _group [protected]

- (NSString*) _schema [protected]

---

Property Documentation

- (NSString*) dataAdapter [read, write, copy]

The name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items in the Group.

If it is nil, the "DEFAULT" name is used.

- (int) end [read, write, assign]

the position of the last item in the Group to be considered.

0 means no constraint.
The default is 0.

- (NSString*) group [read, write, copy]

The name of the Group of items contained in this table.

- (LSMode) mode [read, write, assign]

The subscription mode for the items contained in this table.

- (int) requestedBufferSize [read, write, assign]

the requested size for the Server ItemEventBuffer for all the items in the table.

0 means unlimited buffer. If less than 0, a 1 element buffer is meant if mode is MERGE and an unlimited buffer is meant if mode is DISTINCT. However, the real Server buffer size can be limited by the Metadata Adapter.
NOTE: the buffer size can be specified only for MERGE and DISTINCT modes.
It is ignored if unfilteredDispatch is set.
The default is -1.

- (int) requestedDistinctSnapshotLength [read, write, assign]

The requested length for the snapshot to be received for all the items in the table.

If 0, the snapshot length will be determined by the Server.
NOTE: the snapshot length can be specified only for DISTINCT mode.
The default is 0.

- (double) requestedMaxFrequency [read, write, assign]

The maximum update frequency for all the items in the table.

0.0 means unlimited frequency. It can only be used in order to lower the frequency granted by the Metadata Adapter.
NOTE:The update frequency can be specified only for MERGE, DISTINCT and COMMAND mode; in the latter case, the frequency limit only applies to consecutive UPDATE events for the same key value.
It is ignored if unfilteredDispatch is set.
The default is 0.
Edition Note: a further global frequency limit is also imposed by the Server, if it is running in Presto, Allegro or Moderato edition; this specific limit also applies to RAW mode and to unfiltered dispatching.

- (NSString*) schema [read, write, copy]

The name of the Schema of fields used in this table.

- (NSString*) selector [read, write, copy]

The selector to be applied by the Server to the updates.

- (BOOL) snapshot [read, write, assign]

Whether or not the snapshot is being asked for the items contained in this table.

The default is NO.

- (int) start [read, write, assign]

The position of the first item in the Group to be considered.

0 means no constraint.
The default is 0.

- (BOOL) unfilteredDispatch [read, write, assign]

Events for the items in the table are dispatched in an unfiltered way.

This setting is stronger than the setting of the maximum update frequency and can lead to the subscription refusal by the Metadata Adapter. It is also stronger than the setting for the buffer size.
NOTE: the unfiltered dispatching can be specified only for MERGE, DISTINCT and COMMAND Items mode.
The default is NO.

---

The documentation for this class was generated from the following file:

• LSTableInfo.h