Name 

Description 

Classes 

The following table lists classes in this documentation. 

Interfaces 

The following table lists interfaces in this documentation. 

 

Name 

Description 

 

ClientException 

Base class for all exceptions directly thrown by library methods.  

 

ConnectionConstraints 

Collects the constraints to be applied on the overall data flow from the Connection. They can only be used in order to restrict the constraints set by Lightstreamer Server Metadata Adapter.
Currently, only a constraint on the bandwidth is supported.
 

 

ConnectionInfo 

Collects the parameters related to a connection request to Lightstreamer server.  

 

ExtendedTableInfo 

Contains the specification of a table to be subscribed to Lightstreamer Server. All the items and fields in the table are supplied. 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.  

 

LSClient 

Encapsulates a single connector to Lightstreamer Server. 

 

LSStreamReader 

Using .NET for windows store apps the StreamReader has no Close method. As per documentation (http://msdn.microsoft.com/en-us/library/windows/apps/br230302.aspx) the Dispose method has to be used. Unfortunately such Dispose method can't be overridden, so we wrap the StreamReader class to offer the possibility to override the Close/Dispose method (see MyStreamReader in BatchingHttpProvider). 

 

MessageInfo 

A message object that will be sent to a Lightstreamer Server through a call to LSClient.SendMessage The class contains the message string, the sequence to which such message is associated and a timeout to wait before the server declares lost the previous message in sequence.  

 

PushConnException 

Thrown when the connection to Lightstreamer Server cannot be established or in case of abnormal connection termination. It can be received both in a synchronous and an asynchronous way.  

 

PushServerException 

Thrown in case of an unexpected answer or error condition received from Lightstreamer Server. A detailed error code is supplied, to support automatic recovery actions. It can be received both in a synchronous and an asynchronous way. In normal operation, this exception should never be received.  

 

PushUserException 

Thrown in case the Server refuses to satisfy a request because of the constraints imposed by the Metadata Adapter or by Server configuration. A detailed error code is supplied. Both the error code and the message are received from the Server. In particular:
- A positive error code is issued by the Server after checking the request against the constraints imposed by the Metadata Adapter or by its own configuration. See the text protocol documentation for a reference of the error codes that can be issued in response to the operation performed (i.e. stream/poll, subscription, or synchronous sendMessage request).
-... more 

 

SimpleTableInfo 

Contains the specification of a table to be subscribed to Lightstreamer Server.  

 

SubscrException 

Thrown if a subscription or unsubscription specification is not correct or the request cannot be executed for some reason. 

 

SubscribedTableKey 

Key object to be used to unsubscribe tables. 

 

SubscriptionConstraints 

Collects constraints to be applied on a subscription, to change the currently set parameters for all the involved items. They can only be used in order to restrict the constraints set by Lightstreamer Server Metadata Adapter.
Currently, only a constraint on the maximum update frequency is supported.
 

 

Name 

Description 

 

IConnectionListener 

Receives notifications of connection activity and errors.
The notification sequence follows the pattern:
[CE [SS (NB | DE | AW(true) AW(false) )* [AW(true)] [E | F1 | F2] C] ]
where F1 and F2 represent the two versions of OnFailure().
A distinct listener must be used for any distinct connection opened.
All notifications are sent in sequence on a dedicated thread.
 

 

IHandyTableListener 

A fully-featured listener interface, which receives notification of data updates and subscription termination for a table.
Upon update of each item, the current and previous state of all fields is provided. If the subscription configuration enables the "COMMAND logic", then the special "key" and "command" fields are determined and the updates are meant as ADD, UPDATE and DELETE commands on the rows of an underlying table, identified by a key value. In this case, the old field values related with an update are referred to the same key.
Both names and positional information are available to identify specific items and... more 

 

ISendMessageListener 

Receives notifications of server responses to sent messages. All notifications are sent in sequence on a dedicated thread. 

 

IUpdateInfo 

Implemented by Lightstreamer to provide information about an update for a subscribed item. The new and previous values for the subscribed fields are reported.
If the table subscription configuration enables the "COMMAND logic", then the old field values are referred to the same key.
Both names and positional information can be used to identify the specific fields, unless a SimpleTableInfo was used to describe the related table; in that case, only positional information can be used.