HTML Client 5.0.1

Class Connection

Object
   |
   +--Connection

class Connection


Bean object that contains the configuration settings needed to connect to Lightstreamer Server.
The class constructor, its prototype and any other properties should never be used directly; actually, Connection is not even defined as a global name.
Defined in lscommons.js

See:


Constructor Summary
Connection ()
            Used by Lightstreamer to provide a connection properties bean object to the LightstreamerEngine object.
 
Method Summary
 String getAdapterName()
           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.
 String getLSHost()
           Inquiry method that gets the address of Lightstreamer Server.
 Number getLSPort()
           Inquiry method that gets the TCP port to be used for the connections to Lightstreamer Server.
 String getServerUrlPath()
           Inquiry method that gets the base URL path currently prepended to all request URLs for Lightstreamer Server.
 String getStatusBarUrlPortion()
           Inquiry method that gets the string to be used as the final part of the streaming page URL on the next requests.
 void setAdapterName(<String> adapterName)
           Setter method that sets the name of the Adapter Set mounted on Lightstreamer Server to be used to handle all requests in the session.
 void setLSHost(<String> hostAddress)
           Setter method that sets the address of Lightstreamer Server.
 void setLSPort(<Number> port)
           Setter method that sets the TCP port to be used for all the connections to Lightstreamer Server.
 void setPassword(<String> password)
           Setter method that sets the password to be used for the authentication on Lightstreamer Server when initiating the push session.
 void setServerUrlPath(<String> urlPath)
           Setter method that sets the base URL path to be prepended to all request URLs for Lightstreamer Server.
 void setStatusBarUrlPortion(<String> newPortion)
           Setter method that sets the final part of the streaming page URL.
 void setUserName(<String> user)
           Setter method that sets the username to be used for the authentication on Lightstreamer Server when initiating the push session.

Constructor Detail

Connection

Connection()

Method Detail

getAdapterName

String getAdapterName()

getLSHost

String getLSHost()

getLSPort

Number getLSPort()

getServerUrlPath

String getServerUrlPath()

getStatusBarUrlPortion

String getStatusBarUrlPortion()

setAdapterName

void setAdapterName(<String> adapterName)

setLSHost

void setLSHost(<String> hostAddress)

setLSPort

void setLSPort(<Number> port)

setPassword

void setPassword(<String> password)

setServerUrlPath

void setServerUrlPath(<String> urlPath)

setStatusBarUrlPortion

void setStatusBarUrlPortion(<String> newPortion)

setUserName

void setUserName(<String> user)

HTML Client 5.0.1

Lightstreamer HTML Client API
Documentation generated by JSDoc on Tue May 22 11:46:54 2012