Class ConnectionDetails
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 connectionDetails
Inheritance
System.Object
ConnectionDetails
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Lightstreamer_DotNet_Client_Unified.dll
Syntax
public class ConnectionDetails
Properties
AdapterSet
Declaration
public virtual string AdapterSet { get; set; }
Property Value
Type |
Description |
System.String |
Property AdapterSet represents 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.
The name of the Adapter Set can be null if no name has been configured; that
means that the "DEFAULT" Adapter Set name is used.
Lifecycle: The Adapter Set name should be set on the connectionDetails object before calling the
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.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "adapterSet" on any ClientListener listening to the related LightstreamerClient.
|
ClientIp
Declaration
public virtual string ClientIp { get; }
Property Value
Type |
Description |
System.String |
Read-only property ClientIp represents 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, null is returned;
soon after a session is established, the value may become available; but it is possible
that this information is not provided by the Server and that it will never be available.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "clientIp" on any
ClientListener listening to the related LightstreamerClient.
|
Password
Declaration
public virtual string Password { set; }
Property Value
Type |
Description |
System.String |
Write-only property Password represents 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).
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 connectionDetails object before calling
the 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.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "password" on any
ClientListener listening to the related LightstreamerClient.
|
See Also
ServerAddress
Declaration
public virtual string ServerAddress { get; set; }
Property Value
Type |
Description |
System.String |
Property ServerAddress represents the configured 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).
A null value 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
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).
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.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "serverAddress" on any ClientListener listening to the related LightstreamerClient.
|
ServerInstanceAddress
Declaration
public virtual string ServerInstanceAddress { get; }
Property Value
Type |
Description |
System.String |
Read-only property ServerInstanceAddress represents 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 ServerAddress 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,
null 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).
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: The method gives a meaningful answer only when a session is currently active.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "serverInstanceAddress" on any
ClientListener listening to the related LightstreamerClient.
|
ServerSocketName
Declaration
public virtual string ServerSocketName { get; }
Property Value
Type |
Description |
System.String |
Read-only property ServerSocketName represents 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.
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, null is returned;
soon after a session is established, the value will become available.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "serverSocketName" on any
ClientListener listening to the related LightstreamerClient.
|
SessionId
Declaration
public virtual string SessionId { get; }
Property Value
Type |
Description |
System.String |
Read-only property SessionId represents the ID associated by the server to this client session.
Lifecycle: The method gives a meaningful answer only when a session is currently active.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "sessionId" on any
ClientListener listening to the related LightstreamerClient.
|
User
Declaration
public virtual string User { get; set; }
Property Value
Type |
Description |
System.String |
Property User represents 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).
The User can be null if no user name has been configured. 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 connectionDetails object before
calling the 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.
Related notifications: A change to this setting will be notified through a call to
onPropertyChange(String) with argument "user" on any ClientListener listening to the related LightstreamerClient.
|
See Also