HTML Client 5.0.1

Class Policy

Object
   |
   +--Policy

class Policy


Bean object that contains the configuration settings about connection constraints and fault recovery.
The class constructor, its prototype and any other properties should never be used directly; actually, Policy is not even defined as a global name.
Defined in lscommons.js

See:


Constructor Summary
Policy ()
            Used by Lightstreamer to provide a connection policy properties bean object to the LightstreamerEngine object.
 
Method Summary
 Number 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.
 Number 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.
 Number getMaxBandwidth()
           Inquiry method that gets the maximum bandwidth that can be consumed for the data coming from Lightstreamer Server.
 Number getPollingInterval()
           Inquiry method that gets the polling interval used for polling connections.
 Number getTimeoutForReconnect()
           Inquiry method that gets the time the client Engine, 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.
 Number getTimeoutForStalled()
           Inquiry method that gets the extra time the client Engine 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.
 void setBufferedStreamingHandled()
          
 void setIdleTimeout(<Number> 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(<Number> 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(<Number> maxBandwidth)
           Setter method that sets the maximum bandwidth that can be consumed for the data coming from Lightstreamer Server.
 void setPollingInterval(<Number> pollingInterval)
           Setter method that sets the polling interval used for polling connections.
 void setSlowingEnabled(<boolean> slowingEnabled)
           Setter method that turns on or off the slowing algorithm.
 void setTimeoutForReconnect(<Number> timeoutForReconnect)
           Setter method that sets the time the client Engine, 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 setTimeoutForStalled(<Number> timeoutForStalled)
           Setter method that sets the extra time the client Engine 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.

Constructor Detail

Policy

Policy()

Method Detail

getIdleTimeout

Number getIdleTimeout()

getKeepaliveInterval

Number getKeepaliveInterval()

getMaxBandwidth

Number getMaxBandwidth()

getPollingInterval

Number getPollingInterval()

getTimeoutForReconnect

Number getTimeoutForReconnect()

getTimeoutForStalled

Number getTimeoutForStalled()

setBufferedStreamingHandled

void setBufferedStreamingHandled()

setIdleTimeout

void setIdleTimeout(<Number> idleTimeout)

setKeepaliveInterval

void setKeepaliveInterval(<Number> keepaliveInterval)

setMaxBandwidth

void setMaxBandwidth(<Number> maxBandwidth)

setPollingInterval

void setPollingInterval(<Number> pollingInterval)

setSlowingEnabled

void setSlowingEnabled(<boolean> slowingEnabled)

setTimeoutForReconnect

void setTimeoutForReconnect(<Number> timeoutForReconnect)

setTimeoutForStalled

void setTimeoutForStalled(<Number> timeoutForStalled)

HTML Client 5.0.1

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