Packagecom.lightstreamer.as_client
Classpublic class ConnectionInfo
InheritanceConnectionInfo Inheritance Object

ConnectionInfo collects the parameters related to a connection to Lightstreamer Server.


Public Properties
 PropertyDefined By
  adapterSet : String
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.
ConnectionInfo
  contentLength : int
The length to be used by the Server for the response body on a stream connection (a minimum length, however, is ensured by the server).
ConnectionInfo
  controlPort : uint
The TCP port to be used for the control connections to Lightstreamer Server (default is 8080).
ConnectionInfo
  controlProtocol : String
The protocol to be used for the control connections to Lightstreamer Server.
ConnectionInfo
  password : String
[write-only] The password to be used for the authentication on Lightstreamer Server on session initiation.
ConnectionInfo
  port : uint
The TCP port to be used for the stream/poll connections to Lightstreamer Server (default is 8080).
ConnectionInfo
  protocol : String
The protocol to be used for the stream/poll connections to Lightstreamer Server.
ConnectionInfo
  server : String
The full address of Lightstreamer Server (for instance "push.mycompany.com").
ConnectionInfo
  user : String
The username to be used for the authentication on Lightstreamer Server on session initiation.
ConnectionInfo
Public Methods
 MethodDefined By
  
ConnectionInfo(server:String)
Create an object that encapsulates the connection settings.
ConnectionInfo
Property Detail
adapterSetproperty
adapterSet:String

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 ID is configured through the "id" attribute in the "adapters_conf" element.


Implementation
    public function get adapterSet():String
    public function set adapterSet(value:String):void

See also

com.lightstreamer.as_client.Table.dataAdapter
contentLengthproperty 
contentLength:int

The length to be used by the Server for the response body on a stream connection (a minimum length, however, is ensured by the server). Default value is 50000000 bytes. After the content length exhaustion, the connection will be closed and a new connection will be automatically reopened. If it is 0, the length is decided by the Server.


Implementation
    public function get contentLength():int
    public function set contentLength(value:int):void

Throws
ConfigurationError — An invalid content length is being set.
controlPortproperty 
controlPort:uint

The TCP port to be used for the control connections to Lightstreamer Server (default is 8080). Control connections are used to request item subscriptions or unsubscriptions to the Server and for any backward communication to the Server.


Implementation
    public function get controlPort():uint
    public function set controlPort(value:uint):void

Throws
ConfigurationError — An invalid port number is being set.
controlProtocolproperty 
controlProtocol:String

The protocol to be used for the control connections to Lightstreamer Server. Default is "http"; "https" is also available. Control connections are used to request item subscriptions or unsubscriptions to the Server and to change streaming constraints for an active stream connection. They are usually issued in the same protocol used for stream/poll connections, but using HTTP for control and HTTPS for streaming connections is also meaningful.


Implementation
    public function get controlProtocol():String
    public function set controlProtocol(value:String):void

Throws
ConfigurationError — An invalid protocol is being set.
passwordproperty 
password:String  [write-only]

The password to be used for the authentication on Lightstreamer Server on session initiation. The Metadata Adapter is responsible for credential check.


Implementation
    public function set password(value:String):void
portproperty 
port:uint

The TCP port to be used for the stream/poll connections to Lightstreamer Server (default is 8080).


Implementation
    public function get port():uint
    public function set port(value:uint):void

Throws
ConfigurationError — An invalid port number is being set.
protocolproperty 
protocol:String

The protocol to be used for the stream/poll connections to Lightstreamer Server. Default is "http"; "https" is also available.


Implementation
    public function get protocol():String
    public function set protocol(value:String):void

Throws
ConfigurationError — An invalid protocol is being set.
serverproperty 
server:String

The full address of Lightstreamer Server (for instance "push.mycompany.com").


Implementation
    public function get server():String
    public function set server(value:String):void
userproperty 
user:String

The username to be used for the authentication on Lightstreamer Server on session initiation. The Metadata Adapter is responsible for credential check.


Implementation
    public function get user():String
    public function set user(value:String):void
Constructor Detail
ConnectionInfo()Constructor
public function ConnectionInfo(server:String)

Create an object that encapsulates the connection settings.

Parameters
server:String — The full address of Lightstreamer Server (e.g. "push.mycompany.com").



Lightstreamer Flex client 2.2.1 API