Skip navigation links
A B C D E F G H I L M O P R S T U 

A

AbstractMpnDevice - Class in com.lightstreamer.client.mpn
Abstract class representing a device that supports Mobile Push Notifications (MPN).
It contains device details and the listener needed to monitor its status.
Note: this abstract class is public due to implementation side effects.
AbstractMpnDevice() - Constructor for class com.lightstreamer.client.mpn.AbstractMpnDevice
 
addCookies(URI, List<HttpCookie>) - Static method in class com.lightstreamer.client.LightstreamerClient
Static method that can be used to share cookies between connections to the Server (performed by this library) and connections to other sites that are performed by the application.
addListener(ClientListener) - Method in class com.lightstreamer.client.LightstreamerClient
Adds a listener that will receive events from the LightstreamerClient instance.
addListener(MpnDeviceListener) - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
Adds a listener that will receive events from the MPN device object.
The same listener can be added to several different MPN device objects.
addListener(MpnDeviceListener) - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
Adds a listener that will receive events from the MPN device object.
The same listener can be added to several different MPN device objects.
addListener(MpnSubscriptionListener) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Adds a listener that will receive events from the MpnSubscription instance.
The same listener can be added to several different MpnSubscription instances.
addListener(SubscriptionListener) - Method in class com.lightstreamer.client.Subscription
Adds a listener that will receive events from the Subscription instance.

B

body(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.body field.
body() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.body field.
bodyLocArguments(List<String>) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.body_loc_args field.
bodyLocArguments() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.body_loc_args field.
bodyLocKey(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.body_loc_key field.
bodyLocKey() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.body_loc_key field.
build() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Produces the JSON structure for the push notification format specified by this object.

C

clickAction(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.click_action field.
clickAction() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.click_action field.
ClientListener - Interface in com.lightstreamer.client
Interface to be implemented to listen to LightstreamerClient events comprehending notifications of connection activity and errors.
ClientMessageListener - Interface in com.lightstreamer.client
Interface to be implemented to listen to LightstreamerClient.sendMessage(java.lang.String) events reporting a message processing outcome.
collapseKey(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the collapse_key field.
collapseKey() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of collapse_key field.
color(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.color field.
color() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.color field.
com.lightstreamer.client - package com.lightstreamer.client
 
com.lightstreamer.client.mpn - package com.lightstreamer.client.mpn
 
com.lightstreamer.client.mpn.android - package com.lightstreamer.client.mpn.android
 
com.lightstreamer.client.mpn.util - package com.lightstreamer.client.mpn.util
 
connect() - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that requests to open a Session against the configured Lightstreamer Server.
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.
contentAvailable(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the content_available field with a string value.
contentAvailable(Boolean) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the content_available field with a boolean value.
contentAvailableAsBoolean() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of content_available field as a boolean.
contentAvailableAsString() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of content_available field as a string.
create(Context, String, MpnDevice.MpnDeviceCreationListener) - Static method in class com.lightstreamer.client.mpn.android.MpnDevice
Factory method that creates an MpnDevice object to be registered to the MPN Module of Lightstreamer Server.
During creation the factory method and the MpnDevice try to acquires some more details: The device token, through the Firebase Cloud Messaging APIs. The package name, through the Application Context. Any previously registered device token, from the Shared Preferences storage. The MpnDevice then saves the current device token on the Shared Preferences storage.

D

data(Map<String, String>) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets sub-fields of the data field.
data() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets sub-fields of the data field.
disconnect() - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that requests to close the Session opened against the configured Lightstreamer Server (if any).

E

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

F

findMpnSubscription(String) - Method in class com.lightstreamer.client.LightstreamerClient
Inquiry method that returns the MpnSubscription with the specified subscription ID, or null if not found.
The object returned by this method can be an object created by the user, via MpnSubscription constructors, or an object created by the client, to represent pre-existing MPN subscriptions.
Note that objects returned by this method may be substitutued at any time with equivalent ones: do not rely on pointer matching, instead rely on the MpnSubscription.getSubscriptionId() value to verify the equivalence of two MpnSubscription objects.

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.
getApplicationId() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
The application ID of this MPN device, corresponding to the package name of the application.
getApplicationId() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The application ID of this MPN device, corresponding to the package name of the 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.
getClientIp() - Method in class com.lightstreamer.client.ConnectionDetails
Inquiry method that gets the IP address of this client as seen by the Server which is serving the current session as the client remote address (note that it may not correspond to the client host; for instance it may refer to an intermediate proxy).
getCommandPosition() - Method in class com.lightstreamer.client.Subscription
Returns the position of the "command" field in a COMMAND Subscription.
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.
getCookies(URI) - Static method in class com.lightstreamer.client.LightstreamerClient
Static inquiry method that can be used to share cookies between connections to the Server (performed by this library) and connections to other sites that are performed by the application.
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.mpn.MpnSubscription
Inquiry method that can be used to read the name of the Data Adapter specified for this MpnSubscription through MpnSubscription.setDataAdapter(String).
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).
getDeviceId() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
The server-side unique persistent ID of the device.
The ID is available only after the MPN device object has been successfully registered on the server.
getDeviceId() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The server-side unique persistent ID of the device.
The ID is available only after the MPN device object has been successfully registered on the server.
getDeviceToken() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
The device token of this MPN device.
getDeviceToken() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The device token of this MPN device.
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.mpn.MpnSubscription
Inquiry method that can be used to read the "Field List" specified for this MpnSubscription.
Note: if the MpnSubscription has been created by the client, such as when obtained through LightstreamerClient.getMpnSubscriptions(String), fields are always expressed with a "Field Schema"", even if originally the MPN subscription used a "Field List".
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.mpn.MpnSubscription
Inquiry method that can be used to read the field schema specified for this MpnSubscription.
Note: if the MpnSubscription has been created by the client, such as when obtained through LightstreamerClient.getMpnSubscriptions(String), fields are always expressed with a "Field Schema"", even if originally the MPN subscription used a "Field List".
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.mpn.MpnSubscription
Inquiry method that can be used to read the item group specified for this MpnSubscription.
Note: if the MpnSubscription has been created by the client, such as when obtained through LightstreamerClient.getMpnSubscriptions(String), items are always expressed with an "Item Group"", even if originally the MPN subscription used an "Item List".
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.
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.mpn.MpnSubscription
Inquiry method that can be used to read the "Item List" specified for this MpnSubscription.
Note that if the single-item-constructor was used, this method will return an array of length 1 containing such item.
Note: if the MpnSubscription has been created by the client, such as when obtained through LightstreamerClient.getMpnSubscriptions(String), items are always expressed with an "Item Group"", even if originally the MPN subscription used an "Item List".
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.
getKeyPosition() - Method in class com.lightstreamer.client.Subscription
Returns the position of the "key" field in a COMMAND Subscription.
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.mpn.AbstractMpnDevice
List containing the MpnDeviceListener instances that were added to this MPN device object.
getListeners() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
List containing the MpnDeviceListener instances that were added to this MPN device object.
getListeners() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Returns the list containing the MpnSubscriptionListener instances that were added to this MpnSubscription.
getListeners() - Method in class com.lightstreamer.client.Subscription
Returns a list containing the SubscriptionListener instances that were added to this client.
getMode() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Inquiry method that can be used to read the mode specified for this MpnSubscription.
getMode() - Method in class com.lightstreamer.client.Subscription
Inquiry method that can be used to read the mode specified for this Subscription.
getMpnSubscriptions(String) - Method in class com.lightstreamer.client.LightstreamerClient
Inquiry method that returns a collection of the existing MPN subscription with a specified status.
Can return both objects created by the user, via MpnSubscription constructors, and objects created by the client, to represent pre-existing MPN subscriptions.
Note that objects in the collection may be substitutued at any time with equivalent ones: do not rely on pointer matching, instead rely on the MpnSubscription.getSubscriptionId() value to verify the equivalence of two MpnSubscription objects.
getNotificationFormat() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Returns the JSON structure to be used as the format of push notifications.
This JSON structure is sent by the server to the push notification service provider (i.e.
getPlatform() - Method in class com.lightstreamer.client.mpn.android.MpnDevice
The platform identifier of this MPN device.
getPlatform() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The platform identifier of this MPN device.
getPollingInterval() - Method in class com.lightstreamer.client.ConnectionOptions
Inquiry method that gets the polling interval used for polling connections.
getPreviousDeviceToken() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
The previous device token of this MPN device.
getPreviousDeviceToken() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The previous device token of this MPN device.
getRealMaxBandwidth() - 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.
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.mpn.MpnSubscription
Inquiry method that can be used to read the buffer size, configured though MpnSubscription.setRequestedBufferSize(java.lang.String), to be requested to the Server for this MpnSubscription.
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.
getRequestedMaxBandwidth() - 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, as requested for this session.
getRequestedMaxFrequency() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Inquiry method that can be used to read the max frequency, configured through MpnSubscription.setRequestedMaxFrequency(String), to be requested to the Server for this MpnSubscription.
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).
getStatus() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
The status of the device.
The status can be: UNKNOWN: when the MPN device object has just been created or deleted.
getStatus() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The status of the device.
The status can be: UNKNOWN: when the MPN device object has just been created or deleted.
getStatus() - Method in class com.lightstreamer.client.mpn.MpnSubscription
The status of the subscription.
The status can be: UNKNOWN: when the MPN subscription has just been created or deleted (i.e.
getStatusTimestamp() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
The server-side timestamp of the device status.
getStatusTimestamp() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
The server-side timestamp of the device status.
getStatusTimestamp() - Method in class com.lightstreamer.client.mpn.MpnSubscription
The server-side timestamp of the subscription status.
getSubscriptionId() - Method in class com.lightstreamer.client.mpn.MpnSubscription
The server-side unique persistent ID of the MPN subscription.
The ID is available only after the MPN subscription has been successfully subscribed on the server.
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.
getTriggerExpression() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Returns the boolean expression that is evaluated against each update and acts as a trigger to deliver the push notification.
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 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.
getValue(int, int) - Method in class com.lightstreamer.client.Subscription
Returns the latest value received for the specified item/field pair.
getValue(String, int) - Method in class com.lightstreamer.client.Subscription
Returns the latest value received for the specified item/field pair.
getValue(int, String) - Method in class com.lightstreamer.client.Subscription
Returns the latest value received for the specified item/field pair.

H

hashCode() - Method in class com.lightstreamer.client.mpn.MpnSubscription
 
hashCode() - Method in class com.lightstreamer.client.Proxy
 

I

icon(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.icon field.
icon() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.icon field.
isActive() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Checks if the MpnSubscription is currently "active" or not.
Most of the MpnSubscription properties cannot be modified if an MpnSubscription is "active".
The status of an MpnSubscription is changed to "active" through the LightstreamerClient.subscribe(MpnSubscription, boolean) method and back to "inactive" through the LightstreamerClient.unsubscribe(MpnSubscription) and LightstreamerClient.unsubscribeMpnSubscriptions(String) ones.
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.
isRegistered() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
Checks whether the MPN device object is currently registered on the server or not.
This flag is switched to true by server sent registration events, and back to false in case of client disconnection or server sent suspension events.
isRegistered() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
Checks whether the MPN device object is currently registered on the server or not.
This flag is switched to true by server sent registration events, and back to false in case of client disconnection or server sent suspension events.
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.mpn.MpnSubscription
Checks if the MpnSubscription 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(MpnSubscription) or LightstreamerClient.unsubscribeMpnSubscriptions(String) calls, and server sent unsubscription events.
isSubscribed() - Method in class com.lightstreamer.client.Subscription
Inquiry method that checks if the Subscription is currently subscribed to through the server or not.
isSuspended() - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
Checks whether the MPN device object is currently suspended on the server or not.
An MPN device may be suspended if errors occur during push notification delivery.
This flag is switched to true by server sent suspension events, and back to false in case of client disconnection or server sent resume events.
isSuspended() - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
Checks whether the MPN device object is currently suspended on the server or not.
An MPN device may be suspended if errors occur during push notification delivery.
This flag is switched to true by server sent suspension events, and back to false in case of client disconnection or server sent resume events.
isTriggered() - Method in class com.lightstreamer.client.mpn.MpnSubscription
Checks if the MpnSubscription is currently triggered or not.
This flag is switched to true when a trigger expression has been set and it evaluated to true at least once.
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.

M

MpnBuilder - Class in com.lightstreamer.client.mpn.util
Utility class that provides methods to build or parse the JSON structure used to represent the format of a push notification.
It provides getters and setters for the fields of a push notification, following the format specified by Google's Firebase Cloud Messaging (FCM).
MpnBuilder() - Constructor for class com.lightstreamer.client.mpn.util.MpnBuilder
Creates an empty object to be used to create a push notification format from scratch.
Use setters methods to set the value of push notification fields.
MpnBuilder(String) - Constructor for class com.lightstreamer.client.mpn.util.MpnBuilder
Creates an object based on the specified push notification format.
Use getter methods to obtain the value of push notification fields.
MpnDevice - Class in com.lightstreamer.client.mpn.android
Class representing a device that supports Mobile Push Notifications (MPN).
It contains device details and the listener needed to monitor its status.
An MPN device is created from the application context, the sender ID (a.k.a.
MpnDevice(Context, String, String) - Constructor for class com.lightstreamer.client.mpn.android.MpnDevice
Creates an object to be used to describe an MPN device that is going to be registered to the MPN Module of Lightstreamer Server.
During creation the MpnDevice tries to acquires some more details: The package name, through the Application Context. Any previously registered device token, from the Shared Preferences storage. It then saves the current device token on the Shared Preferences storage.
MpnDevice.MpnDeviceCreationListener - Interface in com.lightstreamer.client.mpn.android
Interface to be implemented to receive success or failure MpnDevice creation events.
MpnDeviceInterface - Interface in com.lightstreamer.client.mpn
Interface representing a device that supports Mobile Push Notifications (MPN).
It contains device details and the listener needed to monitor its status.
After creation, an MpnDevice object is in "unknown" state.
MpnDeviceListener - Interface in com.lightstreamer.client.mpn
Interface to be implemented to receive MPN device events including registration, suspension/resume and status change.
Events for these listeners are dispatched by a different thread than the one that generates them.
MpnSubscription - Class in com.lightstreamer.client.mpn
Class representing a Mobile Push Notifications (MPN) subscription to be submitted to the MPN Module of a Lightstreamer Server.
It contains subscription details and the listener needed to monitor its status.
MpnSubscription(String, String[], String[]) - Constructor for class com.lightstreamer.client.mpn.MpnSubscription
Creates an object to be used to describe an MPN subscription that is going to be subscribed to through the MPN Module of Lightstreamer Server.
The object can be supplied to LightstreamerClient.subscribe(MpnSubscription, boolean) in order to bring the MPN subscription to "active" state.
Note that all of the methods used to describe the subscription to the server can only be called while the instance is in the "inactive" state.
MpnSubscription(String, String, String[]) - Constructor for class com.lightstreamer.client.mpn.MpnSubscription
Creates an object to be used to describe an MPN subscription that is going to be subscribed to through the MPN Module of Lightstreamer Server.
The object can be supplied to LightstreamerClient.subscribe(MpnSubscription, boolean) in order to bring the MPN subscription to "active" state.
Note that all of the methods used to describe the subscription to the server can only be called while the instance is in the "inactive" state.
MpnSubscription(String) - Constructor for class com.lightstreamer.client.mpn.MpnSubscription
Creates an object to be used to describe an MPN subscription that is going to be subscribed to through the MPN Module of Lightstreamer Server.
The object can be supplied to LightstreamerClient.subscribe(MpnSubscription, boolean) in order to bring the MPN subscription to "active" state.
Note that all of the methods used to describe the subscription to the server can only be called while the instance is in the "inactive" state.
MpnSubscription(Subscription) - Constructor for class com.lightstreamer.client.mpn.MpnSubscription
Creates an MpnSubscription object copying subscription mode, items, fields and data adapter from the specified real-time subscription.
The object can be supplied to LightstreamerClient.subscribe(MpnSubscription, boolean) in order to bring the MPN subscription to "active" state.
Note that all of the methods used to describe the subscription to the server can only be called while the instance is in the "inactive" state.
MpnSubscription(MpnSubscription) - Constructor for class com.lightstreamer.client.mpn.MpnSubscription
Creates an MpnSubscription object copying all properties (including the subscription ID) from the specified MPN subscription.
The created MpnSubscription is a copy of the original MpnSubscription object and represents the same MPN subscription, since their subscription ID is the same.
MpnSubscriptionListener - Interface in com.lightstreamer.client.mpn
Interface to be implemented to receive MpnSubscription events including subscription/unsubscription, triggering and status change.
Events for these listeners are dispatched by a different thread than the one that generates them.

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.
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.
onFailure(Exception) - Method in interface com.lightstreamer.client.mpn.android.MpnDevice.MpnDeviceCreationListener
Event handler called when the creation of an MpnDevice failed for some 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(MpnDeviceInterface) - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when the MpnDeviceListener instance is removed from an MPN device object through MpnDeviceInterface.removeListener(MpnDeviceListener).
This is the last event to be fired on the listener.
onListenEnd(MpnSubscription) - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when the MpnSubscriptionListener instance is removed from an MpnSubscription through MpnSubscription.removeListener(MpnSubscriptionListener).
This is the last event to be fired on the listener.
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(MpnDeviceInterface) - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when the MpnDeviceListener instance is added to an MPN device object through MpnDeviceInterface.addListener(MpnDeviceListener).
This is the first event to be fired on the listener.
onListenStart(MpnSubscription) - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when the MpnSubscriptionListener instance is added to an MpnSubscription through MpnSubscription.addListener(MpnSubscriptionListener).
This is the first event to be fired on the listener.
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.
onPropertyChanged(String) - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called each time the value of a property of MpnSubscription is changed.
Properties can be modified by direct calls to their setter or by server sent events.
onRealMaxFrequency(String) - Method in interface com.lightstreamer.client.SubscriptionListener
Event handler that is called by Lightstreamer to notify the client with the real maximum update frequency of the Subscription.
onRegistered() - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when an MPN device object has been successfully registered on the server's MPN Module.
This event handler is always called before other events related to the same device.
Note that this event can be called multiple times in the life of an MPN device object in case the client disconnects and reconnects.
onRegistrationFailed(int, String) - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when the server notifies an error while registering an MPN device object.
By implementing this method it is possible to perform recovery actions.
onResumed() - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when an MPN device object has been resumed on the server's MPN Module.
An MPN device may be resumed from suspended state if a new device token is provided.
Note that in some server clustering configurations this event may not be called.
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.
onStatusChanged(String, long) - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when the server notifies that an MPN device changed its status.
Note that in some server clustering configurations the status change for the MPN device suspend event may not be called.
onStatusChanged(String, long) - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when the server notifies that an MpnSubscription changed its status.
Note that in some server clustering configurations the status change for the MPN subscription's trigger event may not be called.
onSubscription() - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when an MpnSubscription has been successfully subscribed to on the server's MPN Module.
This event handler is always called before other events related to the same subscription.
Note that this event can be called multiple times in the life of an MpnSubscription instance only in case it is subscribed multiple times through LightstreamerClient.unsubscribe(MpnSubscription) and LightstreamerClient.subscribe(MpnSubscription, boolean).
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.mpn.MpnSubscriptionListener
Event handler called when the server notifies an error while subscribing to an MpnSubscription.
By implementing this method it is possible to perform recovery actions.
onSubscriptionError(int, String) - Method in interface com.lightstreamer.client.SubscriptionListener
Event handler that is called when the Server notifies an error on a Subscription.
onSubscriptionsUpdated() - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handled called when the server notifies that the list of MPN subscription associated with an MPN device has been updated.
After registration, the list of pre-existing MPN subscriptions for the MPN device is updated and made avaiable through the LightstreamerClient.getMpnSubscriptions(String) method.
onSuccess(MpnDevice) - Method in interface com.lightstreamer.client.mpn.android.MpnDevice.MpnDeviceCreationListener
Event handler called when an MpnDevice has been successfully created.
onSuspended() - Method in interface com.lightstreamer.client.mpn.MpnDeviceListener
Event handler called when an MPN device object has been suspended on the server's MPN Module.
An MPN device may be suspended if errors occur during push notification delivery.
Note that in some server clustering configurations this event may not be called.
onTriggered() - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when the server notifies that an MpnSubscription did trigger.
For this event to be called the MpnSubscription must have a trigger expression set and it must have been evaluated to true at least once.
Note that this event can be called multiple times in the life of an MpnSubscription instance only in case it is subscribed multiple times through LightstreamerClient.unsubscribe(MpnSubscription) and LightstreamerClient.subscribe(MpnSubscription, boolean).
onUnsubscription() - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when an MpnSubscription has been successfully unsubscribed from on the server's MPN Module.
After this call no more events can be received until a new onSubscription() event.
Note that this event can be called multiple times in the life of an MpnSubscription instance only in case it is subscribed multiple times through LightstreamerClient.unsubscribe(MpnSubscription) and LightstreamerClient.subscribe(MpnSubscription, boolean).
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.
onUnsubscriptionError(int, String) - Method in interface com.lightstreamer.client.mpn.MpnSubscriptionListener
Event handler called when the server notifies an error while unsubscribing from an MpnSubscription.
By implementing this method it is possible to perform recovery actions.

P

priority(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the priority field.
priority() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of priority field.
Proxy - Class in com.lightstreamer.client
Simple class representing a Proxy configuration.
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

registerForMpn(MpnDeviceInterface) - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that registers the MPN device on the server's MPN Module.
By registering an MPN device, the client enables MPN functionalities such as LightstreamerClient.subscribe(MpnSubscription, boolean).
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(MpnDeviceListener) - Method in class com.lightstreamer.client.mpn.AbstractMpnDevice
Removes a listener from the MPN device object so that it will not receive events anymore.
removeListener(MpnDeviceListener) - Method in interface com.lightstreamer.client.mpn.MpnDeviceInterface
Removes a listener from the MPN device object so that it will not receive events anymore.
removeListener(MpnSubscriptionListener) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Removes a listener from the MpnSubscription 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
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.
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.
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.mpn.MpnSubscription
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 MpnSubscription.
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.
setEarlyWSOpenEnabled(boolean) - Method in class com.lightstreamer.client.ConnectionOptions
Setter method that enables/disables the "early-open" of the WebSocket connection.
setFields(String[]) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server.
setFields(String[]) - Method in class com.lightstreamer.client.Subscription
Setter method that sets the "Field List" to be subscribed to through Lightstreamer Server.
setFieldSchema(String) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server.
setFieldSchema(String) - Method in class com.lightstreamer.client.Subscription
Setter method that sets the "Field Schema" to be subscribed to through Lightstreamer Server.
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.
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.mpn.MpnSubscription
Setter method that sets the "Item Group" to be subscribed to through Lightstreamer Server.
setItemGroup(String) - Method in class com.lightstreamer.client.Subscription
Setter method that sets the "Item Group" to be subscribed to through Lightstreamer Server.
setItems(String[]) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Setter method that sets the "Item List" to be subscribed to through Lightstreamer Server.
setItems(String[]) - Method in class com.lightstreamer.client.Subscription
Setter method that sets the "Item List" to be subscribed to through Lightstreamer Server.
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.
setNotificationFormat(String) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Sets the JSON structure to be used as the format of push notifications.
This JSON structure is sent by the server to the push notification service provider (i.e.
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 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.mpn.MpnSubscription
Setter method that sets the length to be requested to Lightstreamer Server for the internal queuing buffers for the items in the MpnSubscription.
A Queuing buffer is used by the Server to accumulate a burst of updates for an item, so that they can all be sent to the client, despite of bandwidth or frequency limits.
Note that the Server may pose an upper limit on the size of its internal buffers.
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.
setRequestedMaxBandwidth(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.
setRequestedMaxFrequency(String) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the MpnSubscription.
Note that frequency limits on the items can also be set on the server side and this request can only be issued in order to furtherly reduce the frequency, not to rise it beyond these limits.
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 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.
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.
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.
setTriggerExpression(String) - Method in class com.lightstreamer.client.mpn.MpnSubscription
Sets the boolean expression that will be evaluated against each update and will act as a trigger to deliver the push notification.
If a trigger expression is set, the MPN subscription does not send any push notifications until the expression evaluates to true.
setTrustManagerFactory(TrustManagerFactory) - Static method in class com.lightstreamer.client.LightstreamerClient
Provides a mean to control the way TLS certificates are evaluated, with the possibility to accept untrusted ones.
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 session.
sound(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.sound field.
sound() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.sound field.
subscribe(Subscription) - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that adds a Subscription to the list of "active" Subscriptions.
subscribe(MpnSubscription, boolean) - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that subscribes an MpnSubscription on server's MPN Module.
This operation adds the MpnSubscription 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.

T

tag(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.tag field.
tag() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.tag field.
timeToLive(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the time_to_live field with a string value.
timeToLive(Integer) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the time_to_live field with an integer value.
timeToLiveAsInteger() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of time_to_live field as an integer.
timeToLiveAsString() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of time_to_live field as a string.
title(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.title field.
title() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.title field.
titleLocArguments(List<String>) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.title_loc_args field.
titleLocArguments() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.title_loc_args field.
titleLocKey(String) - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Sets the notification.title_loc_key field.
titleLocKey() - Method in class com.lightstreamer.client.mpn.util.MpnBuilder
Gets the value of notification.title_loc_key field.
toString() - Method 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.
unsubscribe(MpnSubscription) - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that unsubscribes an MpnSubscription from the server's MPN Module.
This operation removes the MpnSubscription from the list of "active" subscriptions.
unsubscribeMpnSubscriptions(String) - Method in class com.lightstreamer.client.LightstreamerClient
Operation method that subscribes all the MPN subscriptions with a specified status from the server's MPN Module.
By specifying a status filter it is possible to unsubscribe multiple MPN subscriptions at once.
A B C D E F G H I L M O P R S T U 
Skip navigation links