Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.services

ConnectionService

Provides information about the status of a connection to a streaming server.

Constructor Summary

Attributes Name and Description
caplin.services.ConnectionService()

Field Summary

Attributes Name and Description
<static> caplin.services.ConnectionService.STATUS_DOWN

<static> caplin.services.ConnectionService.STATUS_ERROR

<static> caplin.services.ConnectionService.STATUS_OK

<static> caplin.services.ConnectionService.STATUS_PARTIAL

Method Summary

Attributes Name and Description
void addStatusChangedListener(oListener ConnectionServiceListener, bNotifyImmediately Tells)

Adds a ConnectionServiceListener.
void connect()

Connects to the connection service, or do nothing if already connected.
void disconnect()

Disconnects from the connection service or do nothing if already disconnected.
void removeStatusChangedListener(oListener oLitener)

Removes the previously registered ConnectionServiceListener.

Constructor Detail

► caplin.services.ConnectionService()

Field Detail

► <static> caplin.services.ConnectionService.STATUS_DOWN

Deprecated
A constant indicating that this connection is down.

► <static> caplin.services.ConnectionService.STATUS_ERROR

Deprecated
A constant indicating that there is a problem with this connection. Example issues are login failures or session ejections.

► <static> caplin.services.ConnectionService.STATUS_OK

Deprecated
A constant indicating that all sources of data are up and this connection is ok.

► <static> caplin.services.ConnectionService.STATUS_PARTIAL

Deprecated
A constant indicating that not all sources of data are up and this connection is not completely ok. Some data may be missing or stale.

Method Detail

► void addStatusChangedListener(oListener ConnectionServiceListener, bNotifyImmediately Tells)

Adds a ConnectionServiceListener.

Parameters
oListener ConnectionServiceListener implementation that will be called back when a status change occurs.
bNotifyImmediately Tells the ConnectionService if it wants a notification of the current status in the moment the listener is added.
See
#removeStatusChangedListener

► void connect()

Connects to the connection service, or do nothing if already connected.

► void disconnect()

Disconnects from the connection service or do nothing if already disconnected.

► void removeStatusChangedListener(oListener oLitener)

Removes the previously registered ConnectionServiceListener.

Parameters
oListener oLitener The listener to remove.
See
#addStatusChangedListener