Caplin Trader 5.1.0

Class: module:ct-sljsadapter/providers/StreamLinkSubscription

module:ct-sljsadapter/providers/StreamLinkSubscription(streamLink, subject, listener, subscriptionParameters)

The StreamLinkSubscription class provides a StreamLinkJS transport implementation of the module:ct-services/messaging/Subscription interface.

Constructs an instance of StreamLinkSubscription.

Constructor

new module:ct-sljsadapter/providers/StreamLinkSubscription(streamLink, subject, listener, subscriptionParameters)

Parameters:

Name	Type	Description
`streamLink`	caplin.streamlink.StreamLink	The StreamLink that will provide the connection for this subscription.
`subject`	String	The data subject to which to subscribe. Required; non-empty.
`listener`	caplin.streamlink.SubscriptionListener	The listener that will receive subscription events for this subscription.
`subscriptionParameters`	Map	A map of additional parameters for the subscription.

Implements:

module:ct-services/messaging/Subscription

Throws:

if subject is undefined, null or empty

Methods

dispose()

Permanently stops the subscription from receiving new updates to the subject. Should be called when there is no further need for this subscription.

Implements:

module:ct-services/messaging/Subscription#dispose

Throws:

if the subscription has already been disposed of.

getSubject()

Returns the subject that this subscription is subscribed to.

Implements:

module:ct-services/messaging/Subscription#getSubject

Returns:

The subscribed subject.

isDisposed()

Checks whether the subscription has been disposed.

Implements:

module:ct-services/messaging/Subscription#isDisposed

Returns:

true if the subscription is disposed, otherwise false

isPaused()

Returns whether the subscription is currently paused or not.

Implements:

module:ct-services/messaging/Subscription#isPaused

Throws:

if the subscription has been disposed of.

pause()

Temporarily disables the subscription from receiving new updates to the subject.

Implements:

module:ct-services/messaging/Subscription#pause

Throws:

if the subscription has been disposed of.

resume()

Re-enables the subscription, allowing it to receive any new updates to the subject.

Implements:

module:ct-services/messaging/Subscription#resume

Throws:

if the subscription has been disposed of.