Used by LightstreamerClient to provide a basic connection properties data object. More...

#include <ConnectionDetails.h>

Public Member Functions
	ConnectionDetails (const ConnectionDetails &)=delete

ConnectionDetails &	operator= (const ConnectionDetails &)=delete

std::string	getAdapterSet ()
	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.

void	setAdapterSet (const std::string &adapterSet)
	Setter method that sets the name of the Adapter Set mounted on Lightstreamer Server to be used to handle all requests in the session.

std::string	getServerAddress ()
	Inquiry method that gets the configured address of Lightstreamer Server.

void	setServerAddress (const std::string &serverAddress)
	Setter method that sets the address of Lightstreamer Server.

std::string	getUser ()
	Inquiry method that gets the username to be used for the authentication on Lightstreamer Server when initiating the session.

void	setUser (const std::string &user)
	Setter method that sets the username to be used for the authentication on Lightstreamer Server when initiating the session.

std::string	getServerInstanceAddress ()
	Inquiry method that gets the server address to be used to issue all requests related to the current session.

std::string	getServerSocketName ()
	Inquiry method that gets the instance name of the Server which is serving the current session.

std::string	getClientIp ()
	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).

std::string	getSessionId ()
	Inquiry method that gets the ID associated by the server to this client session.

void	setPassword (const std::string &password)
	Setter method that sets the password to be used for the authentication on Lightstreamer Server when initiating the session.

Friends
class	LightstreamerClient

Detailed Description

Used by LightstreamerClient to provide a basic connection properties data object.

Data object that contains the configuration settings needed to connect to a Lightstreamer Server.
An instance of this class is attached to every LightstreamerClient as LightstreamerClient#connectionDetails

See also: LightstreamerClient

Member Function Documentation

◆ getAdapterSet()

std::string Lightstreamer::ConnectionDetails::getAdapterSet ( )

inline

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.

Returns: the adapterSet the name of the Adapter Set; returns an empty string if no name has been configured, that means that the "DEFAULT" Adapter Set is used.

See also: setAdapterSet

◆ getClientIp()

std::string Lightstreamer::ConnectionDetails::getClientIp ( )

inline

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

If, upon a new session, this address changes, it may be a hint that the intermediary network nodes handling the connection have changed, hence the network capabilities may be different. The library uses this information to optimize the connection.

Note that in case of polling or in case rebind requests are needed, subsequent requests related to the same session may, in principle, expose a different IP address to the Server; these changes would not be reported.

Lifecycle If a session is not currently active, an empty string is returned; soon after a session is established, the value may become available.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "clientIp" on any ClientListener listening to the related LightstreamerClient.

Returns: A canonical representation of an IP address (it can be either IPv4 or IPv6), or an empty string.

◆ getServerAddress()

std::string Lightstreamer::ConnectionDetails::getServerAddress ( )

inline

Inquiry method that gets the configured address of Lightstreamer Server.

Returns: the serverAddress the configured address of Lightstreamer Server.

◆ getServerInstanceAddress()

std::string Lightstreamer::ConnectionDetails::getServerInstanceAddress ( )

inline

Inquiry method that gets the server address to be used to issue all requests related to the current session.

In fact, when a Server cluster is in place, the Server address specified through setServerAddress 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. When this is the case, this address is returned by the method; otherwise, an empty string is returned.
Note that the addresses will always have the http: or https: scheme. In case WebSockets are used, the specified scheme is internally converted to match the related WebSocket protocol (i.e. http becomes ws while https becomes wss).

General edition note Server Clustering is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Lifecycle If a session is not currently active, an empty string is returned; soon after a session is established, the value may become available.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "serverInstanceAddress" on any ClientListener listening to the related LightstreamerClient.

Returns: address used to issue all requests related to the current session, or an empty string.

◆ getServerSocketName()

std::string Lightstreamer::ConnectionDetails::getServerSocketName ( )

inline

Inquiry method that gets the instance name of the Server which is serving the current session.

To be more precise, each answering port configured on a Server instance (through a <http_server> or <https_server> element in the Server configuration file) can be given a different name; the name related to the port to which the session opening request has been issued is returned.
Note that each rebind to the same session can, potentially, reach the Server on a port different than the one used for the previous request, depending on the behavior of intermediate nodes. However, the only meaningful case is when a Server cluster is in place and it is configured in such a way that the port used for all bind_session requests differs from the port used for the initial create_session request.

General edition note Server Clustering is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Lifecycle If a session is not currently active, an empty string is returned; soon after a session is established, the value will become available.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "serverSocketName" on any ClientListener listening to the related LightstreamerClient.

Returns: name configured for the Server instance which is managing the current session, or an empty string.

◆ getSessionId()

std::string Lightstreamer::ConnectionDetails::getSessionId ( )

inline

Inquiry method that gets the ID associated by the server to this client session.

Lifecycle If a session is not currently active, an empty string is returned; soon after a session is established, the value will become available.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "sessionId" on any ClientListener listening to the related LightstreamerClient.

Returns: ID assigned by the Server to this client session, or an empty string.

◆ getUser()

std::string Lightstreamer::ConnectionDetails::getUser ( )

inline

Inquiry method that gets the username to be used for the authentication on Lightstreamer Server when initiating the session.

Returns: the username to be used for the authentication on Lightstreamer Server; returns an empty string if no user name has been configured.

◆ setAdapterSet()

void Lightstreamer::ConnectionDetails::setAdapterSet ( const std::string & adapterSet )

inline

Setter method that sets the name of the Adapter Set mounted on Lightstreamer Server to be used to handle all requests in the session.

An Adapter Set defines the Metadata Adapter and one or several Data Adapters. It is configured on the server side through an "adapters.xml" file; the name is configured through the "id" attribute in the <adapters_conf> element.

Default The default Adapter Set, configured as "DEFAULT" on the Server.

Lifecycle The Adapter Set name should be set on the LightstreamerClient#connectionDetails 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 time a new session is requested to the server.
This setting can also be specified in the LightstreamerClient constructor.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "adapterSet" on any ClientListener listening to the related LightstreamerClient.

Parameters

adapterSet The name of the Adapter Set to be used. An empty string is equivalent to the "DEFAULT" name.

◆ setPassword()

void Lightstreamer::ConnectionDetails::setPassword ( const std::string & password )

inline

Setter method that sets the password to be used for the authentication on Lightstreamer Server when initiating the session.

The Metadata Adapter is responsible for checking the credentials (username and password).

Default If no password is supplied, no password information will be sent at session initiation. The Metadata Adapter, however, may still allow the session.

Lifecycle The password should be set on the LightstreamerClient#connectionDetails 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 time a new session is requested to the server.
NOTE: The password string will be stored in the current instance. That is necessary in order to allow automatic reconnection/reauthentication for fail-over. For maximum security, avoid using an actual private password to authenticate on Lightstreamer Server; rather use a session-id originated by your web/application server, that can be checked by your Metadata Adapter.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "password" on any ClientListener listening to the related LightstreamerClient.

Parameters

password The password to be used for the authentication on Lightstreamer Server. The password can be an empty string.

See also: setUser()

◆ setServerAddress()

void Lightstreamer::ConnectionDetails::setServerAddress ( const std::string & serverAddress )

inline

Setter method that sets the address of Lightstreamer Server.

Note that the addresses specified must always have the http: or https: scheme. In case WebSockets are used, the specified scheme is internally converted to match the related WebSocket protocol (i.e. http becomes ws while https becomes wss).

General edition note WSS/HTTPS is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Default if no server address is supplied the client will be unable to connect.

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. This setting can also be specified in the LightstreamerClient constructor.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "serverAddress" on any ClientListener listening to the related LightstreamerClient.

Parameters

serverAddress

The full address of Lightstreamer Server. An empty string can also be used, to restore the default value. An IPv4 or IPv6 can also be used in place of a hostname. Some examples of valid values include:

http://push.mycompany.com
http://push.mycompany.com:8080
http://79.125.7.252
http://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]
http://[2001:0db8:85a3::8a2e:0370:7334]:8080

Exceptions

LightstreamerError if the given address is not valid.

◆ setUser()

void Lightstreamer::ConnectionDetails::setUser ( const std::string & user )

inline

Setter method that sets the username to be used for the authentication on Lightstreamer Server when initiating the session.

The Metadata Adapter is responsible for checking the credentials (username and password).

Default If no username is supplied, no user information will be sent at session initiation. The Metadata Adapter, however, may still allow the session.

Lifecycle The username should be set on the LightstreamerClient#connectionDetails 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 time a new session is requested to the server.

Notification A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "user" on any ClientListener listening to the related LightstreamerClient.

Parameters

user	The username to be used for the authentication on Lightstreamer Server. The username can be an empty string.

See also: setPassword()

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

ConnectionDetails.h

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ getAdapterSet()

◆ getClientIp()

◆ getServerAddress()

◆ getServerInstanceAddress()

◆ getServerSocketName()

◆ getSessionId()

◆ getUser()

◆ setAdapterSet()

◆ setPassword()

◆ setServerAddress()

◆ setUser()