com.lightstreamer.client

Class ConnectionOptions

java.lang.Object

com.lightstreamer.client.ConnectionOptions

public class ConnectionOptions
extends java.lang.Object

Used by LightstreamerClient to provide an extra connection properties bean. Bean object that contains the policy settings used to connect to a Lightstreamer Server.
An instance of this class is attached to every LightstreamerClient as LightstreamerClient.connectionOptions

See Also:

LightstreamerClient

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConnectTimeout() Inquiry method that gets the extra time the client can wait for a response on an opened connection.
long	getContentLength() Inquiry method that gets the length expressed in bytes to be used by the Server for the response body on a HTTP stream connection.
long	getCurrentConnectTimeout() Inquiry method that gets the extra time the client can wait for a response on an opened connection.
long	getFirstRetryMaxDelay() 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.
java.lang.String	getForcedTransport() Inquiry method that gets the value of the forced transport (if any).
java.util.Map<java.lang.String,java.lang.String>	getHttpExtraHeaders() Inquiry method that gets the Map object containing the extra headers to be sent to the server.
long	getIdleTimeout() 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.
long	getKeepaliveInterval() 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.
java.lang.String	getMaxBandwidth() 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.
long	getPollingInterval() 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.
long	getReconnectTimeout() 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.
long	getRetryDelay() 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.
long	getReverseHeartbeatInterval() Inquiry method that gets the reverse-heartbeat interval expressed in milliseconds.
long	getStalledTimeout() 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.
boolean	isEarlyWSOpenEnabled() Inquiry method that checks if the client is going to early-open the WebSocket connection to the address specified in ConnectionDetails.setServerAddress(String).
boolean	isHttpExtraHeadersOnSessionCreationOnly() Inquiry method that checks if the restriction on the forwarding of the configured extra http headers applies or not.
boolean	isServerInstanceAddressIgnored() Inquiry method that checks if the client is going to ignore the server instance address that will possibly be sent by the server.
boolean	isSlowingEnabled() Inquiry method that checks if the slowing algorithm is enabled or not.
void	setConnectTimeout(java.lang.String connectTimeout) 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.
void	setContentLength(long contentLength) 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).
void	setCurrentConnectTimeout(long connectTimeout) 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.
void	setEarlyWSOpenEnabled(boolean earlyWSOpenEnabled) 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.
void	setFirstRetryMaxDelay(long firstRetryMaxDelay) 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.
void	setForcedTransport(java.lang.String forcedTransport) 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.
void	setHttpExtraHeaders(java.util.Map<java.lang.String,java.lang.String> httpExtraHeaders) 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.
void	setHttpExtraHeadersOnSessionCreationOnly(boolean httpExtraHeadersOnSessionCreationOnly) Setter method that enables/disables a restriction on the forwarding of the extra http headers specified through setHttpExtraHeaders(Map).
void	setIdleTimeout(long idleTimeout) 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.
void	setKeepaliveInterval(long keepaliveInterval) 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.
void	setMaxBandwidth(java.lang.String maxBandwidth) Setter method that sets the maximum bandwidth expressed in kilobits/s that can be consumed for the data coming from Lightstreamer Server.
void	setPollingInterval(long pollingInterval) Setter method that sets the polling interval used for polling connections.
void	setProxy(Proxy proxy) Setter method that configures the coordinates to a proxy server to be used to connect to the Lightstreamer Server.
void	setReconnectTimeout(long reconnectTimeout) 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.
void	setRetryDelay(long retryDelay) 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.
void	setReverseHeartbeatInterval(long reverseHeartbeatInterval) Setter method that enables/disables the reverse-heartbeat mechanism on the control connection by setting the heartbeat interval.
void	setServerInstanceAddressIgnored(boolean serverInstanceAddressIgnored) 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.
void	setSlowingEnabled(boolean slowingEnabled) Setter method that turns on or off the slowing algorithm.
void	setStalledTimeout(long stalledTimeout) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConnectTimeout

public java.lang.String getConnectTimeout()

Inquiry method that gets the extra time the client can wait for a response on an opened connection. It can be either a string representation of the number of milliseconds the client can wait or the string "auto" meaning that the client will choose and change the value at will. If "auto" is returned it is possible to check the current value by calling the getCurrentConnectTimeout() method. The getCurrentConnectTimeout method can also be used to get the numeric form in a numeric data type instead of getting it represented as a string.

Returns:

The time (in milliseconds) allowed before recovering a connection that received no data or the String "auto" if the allowed time is not fixed.

See Also:

setConnectTimeout(java.lang.String)

getCurrentConnectTimeout

public long getCurrentConnectTimeout()

Inquiry method that gets the extra time the client can wait for a response on an opened connection. If setConnectTimeout(java.lang.String) is set to "auto" this value might automatically change

Returns:

The time (in milliseconds) allowed before recovering a connection that received no data.

getContentLength

public long getContentLength()

Inquiry method that gets the length expressed in bytes to be used by the Server for the response body on a HTTP stream connection.

Returns:

The length to be used by the Server for the response body on a HTTP stream connection

See Also:

setContentLength(long)

getFirstRetryMaxDelay

public long getFirstRetryMaxDelay()

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.

Returns:

The max time (in milliseconds) to wait before opening a new session.

See Also:

setFirstRetryMaxDelay(long)

getForcedTransport

public java.lang.String getForcedTransport()

Inquiry method that gets the value of the forced transport (if any).

Returns:

The forced transport or null

See Also:

setForcedTransport(String)

getHttpExtraHeaders

public java.util.Map<java.lang.String,java.lang.String> getHttpExtraHeaders()

Inquiry method that gets the Map object containing the extra headers to be sent to the server.

Returns:

The Map object containing the extra headers to be sent

See Also:

setHttpExtraHeaders(Map), setHttpExtraHeadersOnSessionCreationOnly(boolean)

getIdleTimeout

public long getIdleTimeout()

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. The wait time used by the Server, however, may be different, because of server side restrictions.

Returns:

The time (in milliseconds) the Server is allowed to wait for data to send upon polling requests.

See Also:

setIdleTimeout(long)

getKeepaliveInterval

public long getKeepaliveInterval()

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. Afterwards, the returned value is the time used by the Server, that may be different, because of Server side constraints.

Returns:

The time, expressed in milliseconds, between two keepalive packets sent by the Server.

See Also:

setKeepaliveInterval(long)

getMaxBandwidth

public java.lang.String getMaxBandwidth()

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. Afterwards, the returned value is the limit applied by the Server, that may be different, because of Server side constraints.

Returns:

The maximum bandwidth requested for the streaming or polling connection, expressed in kbps (kilobits/sec), or the string "unlimited".

See Also:

setMaxBandwidth(String)

getPollingInterval

public long getPollingInterval()

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. Afterwards, the returned value is the the time between subsequent polling requests that is really allowed by the Server, that may be different, because of Server side constraints.

Returns:

The time (in milliseconds) between subsequent polling requests.

See Also:

setPollingInterval(long)

getReconnectTimeout

public long getReconnectTimeout()

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.

Returns:

The idle time (in milliseconds) admitted in "STALLED" status before trying to reconnect to the Server.

See Also:

setReconnectTimeout(long)

getRetryDelay

public long getRetryDelay()

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.

Returns:

The time (in milliseconds) to wait before opening a new session.

See Also:

setRetryDelay(long)

getReverseHeartbeatInterval

public long getReverseHeartbeatInterval()

Inquiry method that gets the reverse-heartbeat interval expressed in milliseconds.

Returns:

The reverse-heartbeat interval

See Also:

setReverseHeartbeatInterval(long)

getStalledTimeout

public long getStalledTimeout()

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.

Returns:

The idle time (in milliseconds) admitted before entering the "STALLED" status.

See Also:

setStalledTimeout(long)

isEarlyWSOpenEnabled

public boolean isEarlyWSOpenEnabled()

Inquiry method that checks if the client is going to early-open the WebSocket connection to the address specified in ConnectionDetails.setServerAddress(String).

Returns:

true/false if the early-open of the WebSocket connection is enabled or not.

See Also:

setEarlyWSOpenEnabled(boolean)

isHttpExtraHeadersOnSessionCreationOnly

public boolean isHttpExtraHeadersOnSessionCreationOnly()

Inquiry method that checks if the restriction on the forwarding of the configured extra http headers applies or not.

Returns:

the httpExtraHeadersOnSessionCreationOnly

See Also:

setHttpExtraHeadersOnSessionCreationOnly(boolean), setHttpExtraHeaders(Map)

isServerInstanceAddressIgnored

public boolean isServerInstanceAddressIgnored()

Inquiry method that checks if the client is going to ignore the server instance address that will possibly be sent by the server.

Returns:

Whether or not to ignore the server instance address sent by the server.

See Also:

setServerInstanceAddressIgnored(boolean)

isSlowingEnabled

public boolean isSlowingEnabled()

Inquiry method that checks if the slowing algorithm is enabled or not.

Returns:

Whether the slowing algorithm is enabled or not.

See Also:

setSlowingEnabled(boolean)

setConnectTimeout

public void setConnectTimeout(java.lang.String connectTimeout)

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. It can either be a fixed value, in which case the same timeout is always used, or the string "auto" meaning that the library might change this timeout at will.
Streaming: The timeout is applied on any attempt to setup the streaming connection. If after the timeout no data has arrived on the stream connection, the client may automatically switch transport or may resort to a polling connection.
Polling and pre-flight request: The timeout is applied to every connection. If after the timeout no data has arrived on the polling connection, the entire connection process restarts from scratch.

Parameters:

connectTimeout - The time (in milliseconds) allowed before recovering a connection that received no data.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

Lifecycle:

This value can be set and changed at any time.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "connectTimeout" on any ClientListener listening to the related LightstreamerClient.

Default value:

"auto"

setCurrentConnectTimeout

public void setCurrentConnectTimeout(long connectTimeout)

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. If setConnectTimeout(java.lang.String) is set to auto this value might be later changed by the library, on the other hand if setConnectTimeout is configured to a fixed value this method will have no effect

Parameters:

connectTimeout - The time (in milliseconds) allowed before recovering a connection that received no data.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

Lifecycle:

This value can be set and changed at any time.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "currentConnectTimeout" on any ClientListener listening to the related LightstreamerClient.

Default value:

4000 (4 seconds)

setContentLength

public void setContentLength(long contentLength)

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). After the content length exhaustion, the connection will be closed and a new bind connection will be automatically reopened. If it is 0, the length is decided by the Server.
NOTE that this setting only applies to the "HTTP-STREAMING" case (i.e. not to WebSockets).

Parameters:

contentLength - The length to be used by the Server for the response body on a HTTP stream connection.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

Lifecycle:

The content length should be set on the LightstreamerClient.connectionOptions object before calling the LightstreamerClient.connect() method. However, the value can be changed at any time: the supplied value will be used for the next HTTP bind request.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "contentLength" on any ClientListener listening to the related LightstreamerClient.

Default value:

50000000 (50MB)

setEarlyWSOpenEnabled

public void setEarlyWSOpenEnabled(boolean earlyWSOpenEnabled)

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. In this case if a server instance address is received, the previously open WebSocket is closed and a new one is open to the received server instance address.
If disabled, the session creation is completed to verify if such a server instance address is configured in the server before opening the WebSocket.
For these reasons this setting should be set to false if the server specifies a <control_link_address> in its configuration; viceversa it should be set to true if such element is not set on the target server(s) configuration.

Parameters:

earlyWSOpenEnabled - true/false to enable/disable the early-open of the WebSocket connection.

See Also:

setServerInstanceAddressIgnored(boolean)

Edition Note:

Server Clustering is not supported when using Lightstreamer in Moderato edition.

Lifecycle:

This method can be called at any time. If called while the client already owns a session it will be applied the next time a session is requested to a server.

Partial implementation note:

This method is only predisposed for forthcoming extensions. In the current version WebSockets are not enabled, hence this setting has no effect (see setForcedTransport(String)).

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "earlyWSOpenEnabled" on any ClientListener listening to the related LightstreamerClient.

Default value:

true

setFirstRetryMaxDelay

public void setFirstRetryMaxDelay(long firstRetryMaxDelay)

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. The actual delay is a randomized value between 0 and this value. This randomization might help avoid a load spike on the cluster due to simultaneous reconnections, should one of the active servers be stopped. Note that this delay is only applied before the first reconnection: should such reconnection fail the setting of setRetryDelay(long) is applied.

Parameters:

firstRetryMaxDelay - The max time (in milliseconds) to wait before opening a new session.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

Lifecycle:

This value can be set and changed at any time.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "firstRetryMaxDelay" on any ClientListener listening to the related LightstreamerClient.

Default value:

100 (0.1 seconds)

setForcedTransport

public void setForcedTransport(java.lang.String forcedTransport)

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. When a combination is specified the Stream-Sense algorithm is completely disabled.
The method can be used to switch between streaming and polling connection types and between HTTP and WebSocket transports.
In some cases, the requested status may not be reached, because of connection or environment problems. In that case the client will continuously attempt to reach the configured status(es).
Note that if the Stream-Sense algorithm is disabled, the client may still enter the "CONNECTED:STREAM-SENSING" status; however, in that case, if it eventually finds out that streaming is not possible, no recovery will be tried.

Parameters:

forcedTransport - can be one of the following:

• null: the Stream-Sense algorithm is enabled and the client will automatically connect using the most appropriate transport and connection type among those made possible by the environment.
• "WS": the Stream-Sense algorithm is enabled as in the null case but the client will only use WebSocket based connections. If a connection over WebSocket is not possible because of the environment the client will not connect at all.
• "HTTP": the Stream-Sense algorithm is enabled as in the null case but the client will only use HTTP based + connections. If a connection over HTTP is not possible because of the environment the client will not connect at all.
• "WS-STREAMING": the Stream-Sense algorithm is disabled and the client will only connect on Streaming over WebSocket. If Streaming over WebSocket is not possible because of the environment the client will not connect at all.
• "HTTP-STREAMING": the Stream-Sense algorithm is disabled and the client will only connect on Streaming over HTTP. If Streaming over HTTP is not possible because of the browser/environment the client will not connect at all.
• "WS-POLLING": the Stream-Sense algorithm is disabled and the client will only connect on Polling over WebSocket. If Polling over WebSocket is not possible because of the environment the client will not connect at all.
• "HTTP-POLLING": the Stream-Sense algorithm is disabled and the client will only connect on Polling over HTTP. If Polling over HTTP is not possible because of the environment the client will not connect at all.

Throws:

java.lang.IllegalArgumentException - if the given value is not in the list of the admitted ones.

Lifecycle:

This method can be called at any time. If called while the client is connecting or connected it will instruct to switch connection type to match the given configuration.

Partial implementation note:

In the current version WebSockets are not enabled, hence the default is actually "HTTP"; setting this value to "WS", "WS-STREAMING" or "WS-POLLING" will prevent the library from working.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "forcedTransport" on any ClientListener listening to the related LightstreamerClient.

Default value:

null (full Stream-Sense enabled).

setHttpExtraHeaders

public void setHttpExtraHeaders(java.util.Map<java.lang.String,java.lang.String> httpExtraHeaders)

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. The use of custom headers might also cause the client to send an OPTIONS request to the server before opening the actual connection.

Parameters:

httpExtraHeaders - a Map object containing header-name header-value pairs. Null can be specified to avoid extra headers to be sent.

Lifecycle:

This method can be called at any time: each request will carry headers accordingly to the most recent setting. Note that if extra headers are specified while a WebSocket is open, the requests will continue to be sent through the WebSocket and thus this setting will be ignored until a new session starts.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "httpExtraHeaders" on any ClientListener listening to the related LightstreamerClient.

Default value:

null (meaning no extra headers are sent).

setHttpExtraHeadersOnSessionCreationOnly

public void setHttpExtraHeadersOnSessionCreationOnly(boolean httpExtraHeadersOnSessionCreationOnly)

Setter method that enables/disables a restriction on the forwarding of the extra http headers specified through setHttpExtraHeaders(Map). If true, said headers will only be sent during the session creation process (and thus will still be available to the metadata adapter notifyUser method) but will not be sent on following requests. On the contrary, when set to true, the specified extra headers will be sent to the server on every request.

Parameters:

httpExtraHeadersOnSessionCreationOnly - true/false to enable/disable the restriction on extra headers forwarding.

Lifecycle:

This method can be called at any time enabling/disabling the sending of headers on future requests.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "httpExtraHeadersOnSessionCreationOnly" on any ClientListener listening to the related LightstreamerClient.

Default value:

false

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

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. Setting this time to a nonzero value and the polling interval to zero leads to an "asynchronous polling" behavior, which, on low data rates, is very similar to the streaming case. Setting this time to zero and the polling interval to a nonzero value, on the other hand, leads to a classical "synchronous polling".
Note that the Server may, in some cases, delay the answer for more than the supplied time, to protect itself against a high polling rate or because of bandwidth restrictions. Also, the Server may impose an upper limit on the wait time, in order to be able to check for client-side connection drops.

Parameters:

idleTimeout - The time (in milliseconds) the Server is allowed to wait for data to send upon polling requests.

Throws:

java.lang.IllegalArgumentException - if a negative value is configured

Lifecycle:

The idle timeout should be set on the LightstreamerClient.connectionOptions object before calling the LightstreamerClient.connect() method. However, the value can be changed at any time: the supplied value will be used for the next polling request (this only applies to the "*-POLLING" cases).

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "idleTimeout" on any ClientListener listening to the related LightstreamerClient.

Default value:

19000 (19 seconds).

setKeepaliveInterval

public void setKeepaliveInterval(long keepaliveInterval)

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. The Server may, however, impose a lower limit on the keepalive interval, in order to protect itself. Also, the Server may impose an upper limit on the keepalive interval, in order to be able to check for client-side connection drops.

Parameters:

keepaliveInterval - the keepalive interval time (in milliseconds) to set

Throws:

java.lang.IllegalArgumentException - if a negative value is configured

See Also:

setStalledTimeout(long), setReconnectTimeout(long)

Lifecycle:

The keepalive interval should be set on the LightstreamerClient.connectionOptions object before calling the LightstreamerClient.connect() method. However, the value can be changed at any time: the supplied value will be used for the next bind request (this only applies to the "*-STREAMING" cases).
Note that, after a connection, the value may be changed to the one imposed by the Server.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "keepaliveInterval" on any ClientListener listening to the related LightstreamerClient.

Default value:

If no value is supplied, the Server will send keepalive packets based on its own configuration.

setMaxBandwidth

public void setMaxBandwidth(java.lang.String maxBandwidth)

Setter method that sets the maximum bandwidth expressed in kilobits/s that can be consumed for the data coming from Lightstreamer Server. A limit on bandwidth may already be posed by the Metadata Adapter, but the client can furtherly restrict this limit. The limit applies to the bytes received in each streaming or polling connection.

Parameters:

maxBandwidth - The maximum bandwidth requested for the streaming or polling connection, expressed in kbps (kilobits/sec). The string "unlimited" is also allowed, to mean that the maximum bandwidth can be decided on the Server side (the check is case insensitive).

Throws:

java.lang.IllegalArgumentException - if a negative, zero, or a not-number value (excluding special values) is passed.

Edition Note:

The request is ignored by the Server if it runs in Allegro edition (i.e. "unlimited" is assumed).

Edition Note:

The request is ignored by the Server if it runs in Moderato edition (i.e. "unlimited" is assumed).

Lifecycle:

The bandwidth limit can be set and changed at any time. If a connection is currently active, the bandwidth limit for the connection is changed on the fly.
Note that, after a connection, the value may be changed to the one imposed by the Server.

Partial implementation note:

In the current version, the actual value used by the Server is not notified when this method is called at runtime.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "maxBandwidth" on any ClientListener listening to the related LightstreamerClient.

Default value:

"unlimited"

setPollingInterval

public void setPollingInterval(long pollingInterval)

Setter method that sets the polling interval used for polling connections. The client switches from the default streaming mode to polling mode when the client network infrastructure does not allow streaming. Also, polling mode can be forced by calling setForcedTransport(java.lang.String) with "WS-POLLING" or "HTTP-POLLING" as parameter.
The polling interval affects the rate at which polling requests are issued. It is the time between the start of a polling request and the start of the next request. However, if the polling interval expires before the first polling request has returned, then the second polling request is delayed. This may happen, for instance, when the Server delays the answer because of the idle timeout setting. In any case, the polling interval allows for setting an upper limit on the polling frequency.
The Server does not impose a lower limit on the client polling interval. However, in some cases, it may protect itself against a high polling rate by delaying its answer. Network limitations and configured bandwidth limits may also lower the polling rate, despite of the client polling interval.
The Server may, however, impose an upper limit on the polling interval, in order to be able to promptly detect terminated polling request sequences and discard related session information.

Parameters:

pollingInterval - The time (in milliseconds) between subsequent polling requests. Zero is a legal value too, meaning that the client will issue a new polling request as soon as a previous one has returned.

Throws:

java.lang.IllegalArgumentException - if a negative value is configured

Lifecycle:

The polling interval should be set on the LightstreamerClient.connectionOptions object before calling the LightstreamerClient.connect() method. However, the value can be changed at any time: the supplied value will be used for the next bind request (this only applies to the "*-POLLING" cases).
Note that, after each polling request, the value may be changed to the one imposed by the Server.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "pollingInterval" on any ClientListener listening to the related LightstreamerClient.

Default value:

0 (pure "asynchronous polling" is configured).

setReconnectTimeout

public void setReconnectTimeout(long reconnectTimeout)

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.

Parameters:

reconnectTimeout - The idle time (in milliseconds) allowed in "STALLED" status before trying to reconnect to the Server.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

See Also:

setStalledTimeout(long), setKeepaliveInterval(long)

Lifecycle:

This value can be set and changed at any time.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "reconnectTimeout" on any ClientListener listening to the related LightstreamerClient.

Default value:

3000 (3 seconds).

setRetryDelay

public void setRetryDelay(long retryDelay)

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. Note that the delay is calculated from the moment the effort to create a new connection is made, not from the moment the failure is detected or the connection timeout expired.

Parameters:

retryDelay - The time (in milliseconds) to wait before opening a new session.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

Lifecycle:

This value can be set and changed at any time.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "retryDelay" on any ClientListener listening to the related LightstreamerClient.

Default value:

5000 (5 seconds).

setReverseHeartbeatInterval

public void setReverseHeartbeatInterval(long reverseHeartbeatInterval)

Setter method that enables/disables the reverse-heartbeat mechanism on the control connection by setting the heartbeat interval. If the given value (expressed in milliseconds) equals 0 then the reverse-heartbeat mechanism will be disabled; otherwise if the given value is greater than 0 the mechanism will be enabled with the specified interval.
When the mechanism is active the client will send a set of empty control requests to the server, so that there is at most the specified interval between a control request and the following one. The mechanism is not for general use and should only be activated if there is a need to keep the control HTTP connection open even when idle, to avoid connection reestablishment overhead. However it is not guaranteed that the connection will be kept open, as the underlying TCP implementation may open a new socket each time a HTTP request needs to be sent.
NOTE:The mechanism is automatically disabled during polling sessions and/or if the current session transport is a WebSocket.

Parameters:

reverseHeartbeatInterval - the interval, expressed in milliseconds, between subsequent reverse-heartbeats.

Throws:

java.lang.IllegalArgumentException - if a negative value is configured

Lifecycle:

This method can be called at any time enabling/disabling the reverse-heartbeat mechanism on the fly (if applicable).

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "reverseHeartbeatInterval" on any ClientListener listening to the related LightstreamerClient.

Default value:

0 (meaning that the mechanism is disabled).

setServerInstanceAddressIgnored

public void setServerInstanceAddressIgnored(boolean serverInstanceAddressIgnored)

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. This may be needed in a test environment, if the Server address specified is actually a local address to a specific Server instance in the cluster.

Parameters:

serverInstanceAddressIgnored - true or false, to ignore or not the server instance address sent by the server.

See Also:

ConnectionDetails.setServerAddress(String)

Edition Note:

Server Clustering is not supported when using Lightstreamer in Moderato edition.

Lifecycle:

This method can be called at any time. If called while connected, it will be applied when the next session creation request is issued.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "serverInstanceAddressIgnored" on any ClientListener listening to the related LightstreamerClient.

Default value:

false.

setSlowingEnabled

public void setSlowingEnabled(boolean slowingEnabled)

Setter method that turns on or off the slowing algorithm. This heuristic algorithm tries to detect when the client CPU is not able to keep the pace of the events sent by the Server on a streaming connection. In that case, an automatic transition to polling is performed.
In polling, the client handles all the data before issuing the next poll, hence a slow client would just delay the polls, while the Server accumulates and merges the events and ensures that no obsolete data is sent.
Only in very slow clients, the next polling request may be so much delayed that the Server disposes the session first, because of its protection timeouts. In this case, a request for a fresh session will be reissued by the client and this may happen in cycle.

Parameters:

slowingEnabled - true or false, to enable or disable the heuristic algorithm that lowers the item update frequency.

Lifecycle:

The algorithm should be enabled/disabled on the LightstreamerClient.connectionOptions object before calling the LightstreamerClient#connect method. However, the value can be changed at any time: the supplied value will be used for the next connection attempt.

Partial implementation note:

This method is only predisposed for forthcoming extensions. In the current version this setting has no effect.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "slowingEnabled" on any ClientListener listening to the related LightstreamerClient.

Default value:

true.

setStalledTimeout

public void setStalledTimeout(long stalledTimeout)

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.

Parameters:

stalledTimeout - The idle time (in milliseconds) allowed before entering the "STALLED" status.

Throws:

java.lang.IllegalArgumentException - if a negative or zero value is configured

See Also:

setReconnectTimeout(long), setKeepaliveInterval(long)

Lifecycle:

This value can be set and changed at any time.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "stalledTimeout" on any ClientListener listening to the related LightstreamerClient.

Default value:

2000 (2 seconds).

setProxy

public void setProxy(Proxy proxy)

Setter method that configures the coordinates to a proxy server to be used to connect to the Lightstreamer Server.

Parameters:

proxy - The proxy configuration. Specify null to avoid using a proxy.

Lifecycle:

This value can be set and changed at any time. the supplied value will be used for the next connection attempt.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "proxy" on any ClientListener listening to the related LightstreamerClient.

Default value:

null (meaning not to pass through a proxy).