Lightstreamer macOS Client  1.2.5
Native macOS Client library for Lightstreamer
Class Methods | Properties | List of all members
LSExtendedTableInfo Class Reference

The LSExtendedTableInfo class contains the specification of a table to be subscribed to Lightstreamer Server, comprised all the item and field names. More...

#import <LSExtendedTableInfo.h>

Inheritance diagram for LSExtendedTableInfo:
LSTableInfo

Class Methods

(LSExtendedTableInfo *) + extendedTableInfoWithItems:mode:fields:dataAdapter:snapshot:
 Creates and returns an LSExtendedTableInfo object with the specified parameters. More...
 
- Class Methods inherited from LSTableInfo
(LSTableInfo *) + tableInfoWithGroup:mode:schema:dataAdapter:snapshot:
 Creates and returns an LSTableInfo object with the specified parameters. More...
 

Properties

NSArray * items
 The list of strings with the items contained in this table. More...
 
NSArray * fields
 The list of strings with the fields contained in this table. More...
 
- Properties inherited from LSTableInfo
NSString * group
 The name of the Group of items contained in this table. More...
 
LSMode mode
 The subscription mode for the items contained in this table. More...
 
NSString * schema
 The name of the Schema of fields used in this table. More...
 
NSString * adapterSet
 The name of the Adater Set. More...
 
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. More...
 
NSString * selector
 The selector to be applied by the Server to the updates. More...
 
BOOL snapshot
 Whether or not the snapshot is being asked for the items contained in this table. More...
 
int start
 The position of the first item in the Group to be considered. More...
 
int end
 the position of the last item in the Group to be considered. More...
 
int requestedDistinctSnapshotLength
 The requested length for the snapshot to be received for all the items in the table. More...
 
int requestedBufferSize
 the requested size for the Server ItemEventBuffer for all the items in the table. More...
 
double requestedMaxFrequency
 The maximum update frequency for all the items in the table. More...
 
BOOL unfilteredDispatch
 Events for the items in the table are dispatched in an unfiltered way. More...
 

Additional Inherited Members

- Protected Attributes inherited from LSTableInfo
NSString * _group
 
NSString * _schema
 

Detailed Description

The LSExtendedTableInfo class contains the specification of a table to be subscribed to Lightstreamer Server, comprised all the item and field names.

Group and Schema names to be sent to the Server are made by space separated concatenations of item and field names. This name convention is suitable for a Metadata Adapter derived from LiteralBasedProvider or equivalent to it.
Note that, since the LiteralBasedProvider extracts the list of items and fields by splitting the group ID and schema name by spaces, item names and field names cannot contain spaces and must not be empty strings.

Method Documentation

+ (LSExtendedTableInfo *) extendedTableInfoWithItems: (NSArray *)  items
mode: (LSMode mode
fields: (NSArray *)  fields
dataAdapter: (NSString *)  dataAdapter
snapshot: (BOOL)  snapshot 

Creates and returns an LSExtendedTableInfo object with the specified parameters.


Note that item names and field names cannot contain spaces and must not be empty strings.

Parameters
itemsThe list of strings with the items contained in this table.
modeThe subscription mode for the items contained in this table.
fieldsThe list of strings with the fields contained in this table.
dataAdapterThe 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.
snapshotWhether or not the snapshot is being asked for the items contained in this table.
Returns
The LSExtendedTableInfo object.
Exceptions
LSPushClientExceptionIf item names of field names are not valid.

Property Documentation

- (NSArray*) fields
readwritenonatomiccopy

The list of strings with the fields contained in this table.


Note that field names cannot contain spaces and must not be empty strings.

Exceptions
LSPushClientExceptionWhile setting, if field names are not valid.
- (NSArray*) items
readwritenonatomiccopy

The list of strings with the items contained in this table.


Note that item names cannot contain spaces and must not be empty strings.

Exceptions
LSPushClientExceptionWhile setting, if item names are not valid.

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