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

#import <LSTableInfo.h>

Inheritance diagram for LSTableInfo:

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

Protected Attributes
NSString *	_group

NSString *	_schema

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

Detailed Description

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

It may be created and passed to LSClient on calls like subscribeTable:delegate:useCommandLogic: (LSClient), but may also be returned as part of an LSMPNInfo by calls like inquireMPN: (LSClient). In this case some of its properties may not be restored to the value they had when the LSTableInfo has been originally submitted, like requestedBufferSize and requestedMaxFrequency.
Note that instances of this class may be made unmodifiable when stored inside another object (e.g. an LSMPNInfo instance). In this case, trying to change one of the properties causes an LSPushClientException to be raised.

Method 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*) adapterSet

readwritenonatomiccopy

The name of the Adater Set.

When LSTableInfo is used for a new table subscription (or mobile push notification subscription) it is taken from the current session and may be left to nil. If set must correspond to the session's Adapter Set.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (NSString*) dataAdapter

readwritenonatomiccopy

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.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (int) end

readwritenonatomicassign

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

0 means no constraint.
The default is 0.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (NSString*) group

readwritenonatomiccopy

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

When used with an MPN subscription, the content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (LSMode) mode

readwritenonatomicassign

The subscription mode for the items contained in this table.

When used with an MPN subscription, only LSModeMerge and LSModeDistinct may be used.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (int) requestedBufferSize

readwritenonatomicassign

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 LSModeMerge and an unlimited buffer is meant if mode is LSModeDistinct. However, the real Server buffer size can be limited by the Metadata Adapter.
NOTE: the buffer size can be specified only for LSModeMerge and LSModeDistinct modes.
It is ignored if unfilteredDispatch is set.
The default is -1.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (int) requestedDistinctSnapshotLength

readwritenonatomicassign

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 LSModeDistinct mode.
The default is 0.
When used with an MPN subscription, this property must be left to 0.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (double) requestedMaxFrequency

readwritenonatomicassign

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 LSModeMerge, LSModeDistinct and LSModeCommand 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 LSModeRaw and to unfiltered dispatching.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (NSString*) schema

readwritenonatomiccopy

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

When used with an MPN subscription, the content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (NSString*) selector

readwritenonatomiccopy

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

When used with an MPN subscription, this property must be left to nil.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (BOOL) snapshot

readwritenonatomicassign

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

The default is NO.
When used with an MPN subscription, this property must be left to NO.

Exceptions

LSPushClientException Thrown if snapshot is set for modes other than LSModeCommand, LSModeDistinct and LSModeMerge. Thrown also when trying to change the property if the instance has been made unmodifiable.

- (int) start

readwritenonatomicassign

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

0 means no constraint.
The default is 0.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

- (BOOL) unfilteredDispatch

readwritenonatomicassign

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 LSModeMerge, LSModeDistinct and LSModeCommand Items mode.
The default is NO.
When used with an MPN subscription, this property must be left to NO.

Exceptions

LSPushClientException Thrown when trying to change the property if the instance has been made unmodifiable.

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

LSTableInfo.h

Class Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

Member Data Documentation

Property Documentation