Index (Lightstreamer Android Client SDK 2.0.2 API Reference)

A C D E G H I L O P R S T U

A

addListener(ClientListener) - Method in class com.lightstreamer.client.LightstreamerClient: Adds a listener that will receive events from the LightstreamerClient instance.
The same listener can be added to several different LightstreamerClient instances.
addListener(SubscriptionListener) - Method in class com.lightstreamer.client.Subscription: Adds a listener that will receive events from the Subscription instance.
The same listener can be added to several different Subscription instances.
addSubTable(int, String) - Method in class com.lightstreamer.client.Subscription

C

ClientListener - Interface in com.lightstreamer.client: Interface to be implemented to listen to LightstreamerClient events comprehending notifications of connection activity and errors.
Events for these listeners are dispatched by a different thread than the one that generates them.
ClientMessageListener - Interface in com.lightstreamer.client: Interface to be implemented to listen to LightstreamerClient.sendMessage(java.lang.String) events reporting a message processing outcome.
com.lightstreamer.client - package com.lightstreamer.client
connect() - Method in class com.lightstreamer.client.LightstreamerClient: Operation method that requests to open a Session against the configured Lightstreamer Server.
When connect() is called, unless a single transport was forced through ConnectionOptions.setForcedTransport(String), the so called "Stream-Sense" mechanism is started: if the client does not receive any answer for some seconds from the streaming connection, then it will automatically open a polling connection.
A polling connection may also be opened if the environment is not suitable for a streaming connection.
Note that as "polling connection" we mean a loop of polling requests, each of which requires opening a synchronous (i.e.
ConnectionDetails - Class in com.lightstreamer.client: Used by LightstreamerClient to provide a basic connection properties bean.
connectionDetails - Variable in class com.lightstreamer.client.LightstreamerClient: Bean object that contains the details needed to open a connection to a Lightstreamer Server.
ConnectionOptions - Class in com.lightstreamer.client: Used by LightstreamerClient to provide an extra connection properties bean.
connectionOptions - Variable in class com.lightstreamer.client.LightstreamerClient: Bean object that contains options and policies for the connection to the server.

D

debugDescriptor(String, Descriptor) - Method in class com.lightstreamer.client.Subscription
disconnect() - Method in class com.lightstreamer.client.LightstreamerClient: Operation method that requests to close the Session opened against the configured Lightstreamer Server (if any).
When disconnect() is called, the "Stream-Sense" mechanism is stopped.
Note that active Subscription instances, associated with this LightstreamerClient instance, are preserved to be re-subscribed to on future Sessions.

E

equals(Object) - Method in class com.lightstreamer.client.Proxy

G

getAdapterSet() - Method in class com.lightstreamer.client.ConnectionDetails: Inquiry method that gets the name of the Adapter Set (which defines the Metadata Adapter and one or several Data Adapters) mounted on Lightstreamer Server that supply all the items used in this application.
getChangedFields() - Method in class com.lightstreamer.client.ItemUpdate: Returns an immutable Map containing the values for each field changed with the last server update.
getChangedFieldsByPosition() - Method in class com.lightstreamer.client.ItemUpdate: Returns an immutable Map containing the values for each field changed with the last server update.
getCommandPosition() - Method in class com.lightstreamer.client.Subscription: Returns the position of the "command" field in a COMMAND Subscription.
This method can only be used if the Subscription mode is COMMAND and the Subscription was initialized using a "Field Schema".
getCommandSecondLevelDataAdapter() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the second-level Data Adapter name configured through Subscription.setCommandSecondLevelDataAdapter(String).
getCommandSecondLevelFields() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the "Field List" specified for second-level Subscriptions.
getCommandSecondLevelFieldSchema() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the "Field Schema" specified for second-level Subscriptions.
getCommandValue(String, String, String) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/key/field combination.
getCommandValue(int, String, int) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/key/field combination.
getCommandValue(int, String, String) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/key/field combination.
getCommandValue(String, String, int) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/key/field combination.
getConnectTimeout() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the extra time the client can wait for a response on an opened connection.
getContentLength() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the length expressed in bytes to be used by the Server for the response body on a HTTP stream connection.
getCurrentConnectTimeout() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the extra time the client can wait for a response on an opened connection.
getDataAdapter() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the name of the Data Adapter specified for this Subscription through Subscription.setDataAdapter(String).
getFields() - Method in class com.lightstreamer.client.ItemUpdate: Returns an immutable Map containing the values for each field in the Subscription.
getFields() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the "Field List" specified for this Subscription.
getFieldsByPosition() - Method in class com.lightstreamer.client.ItemUpdate: Returns an immutable Map containing the values for each field in the Subscription.
getFieldSchema() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the field schema specified for this Subscription.
getFirstRetryMaxDelay() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the maximum time the client will wait before opening a new session in case the previous one is unexpectedly closed while correctly working.
getForcedTransport() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the value of the forced transport (if any).
getHttpExtraHeaders() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the Map object containing the extra headers to be sent to the server.
getIdleTimeout() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the maximum time the Server is allowed to wait for any data to be sent in response to a polling request, if none has accumulated at request time.
getItemGroup() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the item group specified for this Subscription.
getItemName() - Method in class com.lightstreamer.client.ItemUpdate: Inquiry method that retrieves the name of the item to which this update pertains.
The name will be null if the related Subscription was initialized using an "Item Group".
getItemPos() - Method in class com.lightstreamer.client.ItemUpdate: Inquiry method that retrieves the position in the "Item List" or "Item Group" of the item to which this update pertains.
getItems() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the "Item List" specified for this Subscription.
getKeepaliveInterval() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the interval between two keepalive packets sent by Lightstreamer Server on a stream connection when no actual data is being transmitted.
If the value has just been set and a connection to Lightstreamer Server has not been established yet, the returned value is the time that is being requested to the Server.
getKeyPosition() - Method in class com.lightstreamer.client.Subscription: Returns the position of the "key" field in a COMMAND Subscription.
This method can only be used if the Subscription mode is COMMAND and the Subscription was initialized using a "Field Schema".
getListeners() - Method in class com.lightstreamer.client.LightstreamerClient: Returns a list containing the ClientListener instances that were added to this client.
getListeners() - Method in class com.lightstreamer.client.Subscription: Returns a list containing the SubscriptionListener instances that were added to this client.
getMaxBandwidth() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the maximum bandwidth that can be consumed for the data coming from Lightstreamer Server.
If the value has just been set and a connection to Lightstreamer Server has not been established yet, the returned value is the bandwidth limit that is being requested to the Server.
getMode() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the mode specified for this Subscription.
getPollingInterval() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the polling interval used for polling connections.
If the value has just been set and a polling request to Lightstreamer Server has not been performed yet, the returned value is the polling interval that is being requested to the Server.
getReconnectTimeout() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the time the client, after entering "STALLED" status, can wait for a keepalive packet or any data on a stream connection, before disconnecting and trying to reconnect to the Server.
getRequestedBufferSize() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the buffer size, configured though Subscription.setRequestedBufferSize(java.lang.String), to be requested to the Server for this Subscription.
getRequestedMaxFrequency() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the max frequency, configured through Subscription.setRequestedMaxFrequency(String), to be requested to the Server for this Subscription.
getRequestedSnapshot() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the snapshot preferences, configured through Subscription.setRequestedSnapshot(String), to be requested to the Server for this Subscription.
getRetryDelay() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the time the client can wait before opening a new session in case the previous one failed to open or was closed before it became stable.
getReverseHeartbeatInterval() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the reverse-heartbeat interval expressed in milliseconds.
getSelector() - Method in class com.lightstreamer.client.Subscription: Inquiry method that can be used to read the selector name specified for this Subscription through Subscription.setSelector(String).
getServerAddress() - Method in class com.lightstreamer.client.ConnectionDetails: Inquiry method that gets the configured address of Lightstreamer Server.
getServerInstanceAddress() - Method in class com.lightstreamer.client.ConnectionDetails: Inquiry method that gets the server address to be used to issue all requests related to the current session.
getServerSocketName() - Method in class com.lightstreamer.client.ConnectionDetails: Inquiry method that gets the instance name of the Server which is serving the current session.
getSessionId() - Method in class com.lightstreamer.client.ConnectionDetails: Inquiry method that gets the ID associated by the server to this client session.
getStalledTimeout() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that gets the extra time the client can wait when an expected keepalive packet has not been received on a stream connection (and no actual data has arrived), before entering the "STALLED" status.
getStatus() - Method in class com.lightstreamer.client.LightstreamerClient: Inquiry method that gets the current client status and transport (when applicable).
getSubscriptions() - Method in class com.lightstreamer.client.LightstreamerClient: Inquiry method that returns a list containing all the Subscription instances that are currently "active" on this LightstreamerClient.
Internal second-level Subscription are not included.
getUser() - Method in class com.lightstreamer.client.ConnectionDetails: Inquiry method that gets the username to be used for the authentication on Lightstreamer Server when initiating the push session.
getValue(String) - Method in class com.lightstreamer.client.ItemUpdate: Returns the current value for the specified field
getValue(int) - Method in class com.lightstreamer.client.ItemUpdate: Returns the current value for the specified field
getValue(String, String) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/field pair.
It is suggested to consume real-time data by implementing and adding a proper SubscriptionListener rather than probing this method.
In case of COMMAND Subscriptions, the value returned by this method may be misleading, as in COMMAND mode all the keys received, being part of the same item, will overwrite each other; for COMMAND Subscriptions, use Subscription.getCommandValue(java.lang.String, java.lang.String, java.lang.String) instead.
Note that internal data is cleared when the Subscription is unsubscribed from.
getValue(int, int) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/field pair.
It is suggested to consume real-time data by implementing and adding a proper SubscriptionListener rather than probing this method.
In case of COMMAND Subscriptions, the value returned by this method may be misleading, as in COMMAND mode all the keys received, being part of the same item, will overwrite each other; for COMMAND Subscriptions, use Subscription.getCommandValue(java.lang.String, java.lang.String, java.lang.String) instead.
Note that internal data is cleared when the Subscription is unsubscribed from.
getValue(String, int) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/field pair.
It is suggested to consume real-time data by implementing and adding a proper SubscriptionListener rather than probing this method.
In case of COMMAND Subscriptions, the value returned by this method may be misleading, as in COMMAND mode all the keys received, being part of the same item, will overwrite each other; for COMMAND Subscriptions, use Subscription.getCommandValue(java.lang.String, java.lang.String, java.lang.String) instead.
Note that internal data is cleared when the Subscription is unsubscribed from.
getValue(int, String) - Method in class com.lightstreamer.client.Subscription: Returns the latest value received for the specified item/field pair.
It is suggested to consume real-time data by implementing and adding a proper SubscriptionListener rather than probing this method.
In case of COMMAND Subscriptions, the value returned by this method may be misleading, as in COMMAND mode all the keys received, being part of the same item, will overwrite each other; for COMMAND Subscriptions, use Subscription.getCommandValue(java.lang.String, java.lang.String, java.lang.String) instead.
Note that internal data is cleared when the Subscription is unsubscribed from.

H

hashCode() - Method in class com.lightstreamer.client.Proxy
host - Variable in class com.lightstreamer.client.Proxy

I

isActive() - Method in class com.lightstreamer.client.Subscription: Inquiry method that checks if the Subscription is currently "active" or not.
isEarlyWSOpenEnabled() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that checks if the client is going to early-open the WebSocket connection to the address specified in ConnectionDetails.setServerAddress(String).
isHttpExtraHeadersOnSessionCreationOnly() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that checks if the restriction on the forwarding of the configured extra http headers applies or not.
isServerInstanceAddressIgnored() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that checks if the client is going to ignore the server instance address that will possibly be sent by the server.
isSlowingEnabled() - Method in class com.lightstreamer.client.ConnectionOptions: Inquiry method that checks if the slowing algorithm is enabled or not.
isSnapshot() - Method in class com.lightstreamer.client.ItemUpdate: Inquiry method that asks whether the current update belongs to the item snapshot (which carries the current item state at the time of Subscription).
isSubscribed() - Method in class com.lightstreamer.client.Subscription: Inquiry method that checks if the Subscription is currently subscribed to through the server or not.
This flag is switched to true by server sent Subscription events, and back to false in case of client disconnection, LightstreamerClient.unsubscribe(Subscription) calls and server sent unsubscription events.
isValueChanged(String) - Method in class com.lightstreamer.client.ItemUpdate: Inquiry method that asks whether the value for a field has changed after the reception of the last update from the Server for an item.
isValueChanged(int) - Method in class com.lightstreamer.client.ItemUpdate: Inquiry method that asks whether the value for a field has changed after the reception of the last update from the Server for an item.
ItemUpdate - Class in com.lightstreamer.client: Contains all the information related to an update of the field values for an item.

L

LIB_NAME - Static variable in class com.lightstreamer.client.LightstreamerClient: A constant string representing the name of the library.
LIB_VERSION - Static variable in class com.lightstreamer.client.LightstreamerClient: A constant string representing the version of the library.
LightstreamerClient - Class in com.lightstreamer.client: Facade class for the management of the communication to Lightstreamer Server.
LightstreamerClient(String, String) - Constructor for class com.lightstreamer.client.LightstreamerClient: Creates an object to be configured to connect to a Lightstreamer server and to handle all the communications with it.

O

onAbort(String, boolean) - Method in interface com.lightstreamer.client.ClientMessageListener: Event handler that is called by Lightstreamer when any notifications of the processing outcome of the related message haven't been received yet and can no longer be received.
onClearSnapshot(String, int) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called by Lightstreamer each time a request to clear the snapshot pertaining to an item in the Subscription has been received from the Server.
onCommandSecondLevelItemLostUpdates(int, String) - Method in interface com.lightstreamer.client.SubscriptionListener: 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 that was subscribed to as a second-level subscription.
onCommandSecondLevelSubscriptionError(int, String, String) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called when the Server notifies an error on a second-level subscription.
By implementing this method it is possible to perform recovery actions.
onDeny(String, int, String) - Method in interface com.lightstreamer.client.ClientMessageListener: Event handler that is called by Lightstreamer when the related message has been processed by the Server but the expected processing outcome could not be achieved for any reason.
onDiscarded(String) - Method in interface com.lightstreamer.client.ClientMessageListener: Event handler that is called by Lightstreamer to notify that the related message has been discarded by the Server.
onEndOfSnapshot(String, int) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called by Lightstreamer to notify that all snapshot events for an item in the Subscription have been received, so that real time events are now going to be received.
onError(String) - Method in interface com.lightstreamer.client.ClientMessageListener: Event handler that is called by Lightstreamer when the related message has been processed by the Server but the processing has failed for any reason.
onItemLostUpdates(String, int, int) - Method in interface com.lightstreamer.client.SubscriptionListener: 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 Subscription.
onItemUpdate(ItemUpdate) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called by Lightstreamer each time an update pertaining to an item in the Subscription has been received from the Server.
onListenEnd(LightstreamerClient) - Method in interface com.lightstreamer.client.ClientListener: Event handler that receives a notification when the ClientListener instance is removed from a LightstreamerClient through LightstreamerClient.removeListener(ClientListener).
onListenEnd(Subscription) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that receives a notification when the SubscriptionListener instance is removed from a Subscription through Subscription.removeListener(SubscriptionListener).
onListenStart(LightstreamerClient) - Method in interface com.lightstreamer.client.ClientListener: Event handler that receives a notification when the ClientListener instance is added to a LightstreamerClient through LightstreamerClient.addListener(ClientListener).
onListenStart(Subscription) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that receives a notification when the SubscriptionListener instance is added to a Subscription through Subscription.addListener(SubscriptionListener).
onProcessed(String) - Method in interface com.lightstreamer.client.ClientMessageListener: Event handler that is called by Lightstreamer when the related message has been processed by the Server with success.
onPropertyChange(String) - Method in interface com.lightstreamer.client.ClientListener: Event handler that receives a notification each time the value of a property of LightstreamerClient.connectionDetails or LightstreamerClient.connectionOptions is changed.
Properties of these objects can be modified by direct calls to them orr by server sent events.
onServerError(int, String) - Method in interface com.lightstreamer.client.ClientListener: Event handler that is called when the Server notifies a refusal on the client attempt to open a new connection or the interruption of a streaming connection.
onStatusChange(String) - Method in interface com.lightstreamer.client.ClientListener: Event handler that receives a notification each time the LightstreamerClient status has changed.
onSubscription() - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called by Lightstreamer to notify that a Subscription has been successfully subscribed to through the Server.
onSubscriptionError(int, String) - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called when the Server notifies an error on a Subscription.
onUnsubscription() - Method in interface com.lightstreamer.client.SubscriptionListener: Event handler that is called by Lightstreamer to notify that a Subscription has been successfully unsubscribed from.

P

password - Variable in class com.lightstreamer.client.Proxy
port - Variable in class com.lightstreamer.client.Proxy
Proxy - Class in com.lightstreamer.client: Simple class representing a Proxy configuration.
An instance of this class can be used through ConnectionOptions.setProxy(Proxy) to instruct a LightstreamerClient to connect to the Lightstreamer Server passing through a proxy.
Proxy(String, String, int) - Constructor for class com.lightstreamer.client.Proxy: This constructor will call Proxy.Proxy(String, String, int, String, String) specifying null user and null password.
Proxy(String, String, int, String) - Constructor for class com.lightstreamer.client.Proxy: This constructor will call Proxy.Proxy(String, String, int, String, String) specifying a null null password.
Proxy(String, String, int, String, String) - Constructor for class com.lightstreamer.client.Proxy: Creates a Proxy instance containing all the informations required by the LightstreamerClient to connect to a Lightstreamer server passing through a proxy.

R

removeListener(ClientListener) - Method in class com.lightstreamer.client.LightstreamerClient: Removes a listener from the LightstreamerClient instance so that it will not receive events anymore.
removeListener(SubscriptionListener) - Method in class com.lightstreamer.client.Subscription: Removes a listener from the Subscription instance so that it will not receive events anymore.

S

sendMessage(String) - Method in class com.lightstreamer.client.LightstreamerClient: A simplified version of the LightstreamerClient.sendMessage(String,String,int,ClientMessageListener,boolean).
sendMessage(String, String, int, ClientMessageListener, boolean) - Method in class com.lightstreamer.client.LightstreamerClient: Operation method that sends a message to the Server.
setAdapterSet(String) - Method in class com.lightstreamer.client.ConnectionDetails: Setter method that sets the name of the Adapter Set mounted on Lightstreamer Server to be used to handle all requests in the session.
An Adapter Set defines the Metadata Adapter and one or several Data Adapters.
setCommandSecondLevelDataAdapter(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the name of the second-level Data Adapter (within the Adapter Set used by the current session) that supplies all the second-level items.
All the possible second-level items should be supplied in "MERGE" mode with snapshot available.
The Data Adapter name is configured on the server side through the "name" attribute of the <data_provider> element, in the "adapters.xml" file that defines the Adapter Set (a missing attribute configures the "DEFAULT" name).
setCommandSecondLevelFields(String[]) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server for the second-level items.
setCommandSecondLevelFieldSchema(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server for the second-level items.
setConnectTimeout(String) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the time the client is allowed to wait for a response to a request before dropping the connection and try with a different approach.
setContentLength(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the length in bytes to be used by the Server for the response body on a stream connection (a minimum length, however, is ensured by the server).
setCurrentConnectTimeout(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the time the client is allowed to wait for a response to a request before dropping the connection and try with a different approach.
setDataAdapter(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items for this Subscription.
The Data Adapter name is configured on the server side through the "name" attribute of the "data_provider" element, in the "adapters.xml" file that defines the Adapter Set (a missing attribute configures the "DEFAULT" name).
Note that if more than one Data Adapter is needed to supply all the items in a set of items, then it is not possible to group all the items of the set in a single Subscription.
setEarlyWSOpenEnabled(boolean) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that enables/disables the "early-open" of the WebSocket connection.
When enabled a WebSocket is open to the address specified through ConnectionDetails.setServerAddress(java.lang.String) before a potential server instance address is received during session creation.
setFields(String[]) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server.
Any call to this method will override any "Field List" or "Field Schema" previously specified.
setFieldSchema(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server.
Any call to this method will override any "Field List" or "Field Schema" previously specified.
setFirstRetryMaxDelay(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the maximum time to wait before opening a new session in case the previous one is unexpectedly closed while correctly working.
setForcedTransport(String) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that can be used to disable/enable the Stream-Sense algorithm and to force the client to use a fixed transport or a fixed combination of a transport and a connection type.
setHttpExtraHeaders(Map<String, String>) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that enables/disables the setting of extra HTTP headers to all the request performed to the Lightstreamer server by the client.
Note that the Content-Type header is reserved by the client library itself, while other headers might be refused by the environment and others might cause the connection to the server to fail.
setHttpExtraHeadersOnSessionCreationOnly(boolean) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that enables/disables a restriction on the forwarding of the extra http headers specified through ConnectionOptions.setHttpExtraHeaders(Map).
setIdleTimeout(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the maximum time the Server is allowed to wait for any data to be sent in response to a polling request, if none has accumulated at request time.
setItemGroup(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the "Item Group" to be subscribed to through Lightstreamer Server.
Any call to this method will override any "Item List" or "Item Group" previously specified.
setItems(String[]) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the "Item List" to be subscribed to through Lightstreamer Server.
Any call to this method will override any "Item List" or "Item Group" previously specified.
setKeepaliveInterval(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the interval between two keepalive packets to be sent by Lightstreamer Server on a stream connection when no actual data is being transmitted.
setLoggerProvider(LoggerProvider) - Static method in class com.lightstreamer.client.LightstreamerClient: Static method that permits to configure the logging system used by the library.
setMaxBandwidth(String) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the maximum bandwidth expressed in kilobits/s that can be consumed for the data coming from Lightstreamer Server.
setPassword(String) - Method in class com.lightstreamer.client.ConnectionDetails: Setter method that sets the password to be used for the authentication on Lightstreamer Server when initiating the push session.
setPollingInterval(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the polling interval used for polling connections.
setProxy(Proxy) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that configures the coordinates to a proxy server to be used to connect to the Lightstreamer Server.
setReconnectTimeout(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the time the client, after entering "STALLED" status, is allowed to wait for a keepalive packet or any data on a stream connection, before disconnecting and trying to reconnect to the Server.
setRequestedBufferSize(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the length to be requested to Lightstreamer Server for the internal queuing buffers for the items in the Subscription.
setRequestedMaxFrequency(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the Subscription.
setRequestedSnapshot(String) - Method in class com.lightstreamer.client.Subscription: Setter method that enables/disables snapshot delivery request for the items in the Subscription.
setRetryDelay(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the time to wait before opening a new session in case the previous one failed to open or was closed before it became stable.
setReverseHeartbeatInterval(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that enables/disables the reverse-heartbeat mechanism on the control connection by setting the heartbeat interval.
setSelector(String) - Method in class com.lightstreamer.client.Subscription: Setter method that sets the selector name for all the items in the Subscription.
setServerAddress(String) - Method in class com.lightstreamer.client.ConnectionDetails: Setter method that sets the address of Lightstreamer Server.
Note that the addresses specified must always have the http: or https: scheme.
setServerInstanceAddressIgnored(boolean) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that can be used to disable/enable the automatic handling of server instance address that may be returned by the Lightstreamer server during session creation.
In fact, when a Server cluster is in place, the Server address specified through ConnectionDetails.setServerAddress(String) can identify various Server instances; in order to ensure that all requests related to a session are issued to the same Server instance, the Server can answer to the session opening request by providing an address which uniquely identifies its own instance.
Setting this value to true permits to ignore that address and to always connect through the address supplied in setServerAddress.
setSlowingEnabled(boolean) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that turns on or off the slowing algorithm.
setStalledTimeout(long) - Method in class com.lightstreamer.client.ConnectionOptions: Setter method that sets the extra time the client is allowed to wait when an expected keepalive packet has not been received on a stream connection (and no actual data has arrived), before entering the "STALLED" status.
setUser(String) - Method in class com.lightstreamer.client.ConnectionDetails: Setter method that sets the username to be used for the authentication on Lightstreamer Server when initiating the push session.
subMode - Variable in class com.lightstreamer.client.Subscription
subscribe(Subscription) - Method in class com.lightstreamer.client.LightstreamerClient: Operation method that adds a Subscription to the list of "active" Subscriptions.
Subscription - Class in com.lightstreamer.client: Class representing a Subscription to be submitted to a Lightstreamer Server.
Subscription(String, String[], String[]) - Constructor for class com.lightstreamer.client.Subscription: Creates an object to be used to describe a Subscription that is going to be subscribed to through Lightstreamer Server.
Subscription(String, String, String[]) - Constructor for class com.lightstreamer.client.Subscription: Creates an object to be used to describe a Subscription that is going to be subscribed to through Lightstreamer Server.
Subscription(String) - Constructor for class com.lightstreamer.client.Subscription: Creates an object to be used to describe a Subscription that is going to be subscribed to through Lightstreamer Server.
SubscriptionListener - Interface in com.lightstreamer.client: Interface to be implemented to listen to Subscription events comprehending notifications of subscription/unsubscription, updates, errors and others.
Events for these listeners are dispatched by a different thread than the one that generates them.

T

toString() - Method in class com.lightstreamer.client.Proxy
type - Variable in class com.lightstreamer.client.Proxy

U

unsubscribe(Subscription) - Method in class com.lightstreamer.client.LightstreamerClient: Operation method that removes a Subscription that is currently in the "active" state.
By bringing back a Subscription to the "inactive" state, the unsubscription from all its items is requested to Lightstreamer Server.
user - Variable in class com.lightstreamer.client.Proxy

A C D E G H I L O P R S T U