Caplin Trader 4.8.0

Class: module:caplin/sljsadapter/providers/StreamLinkSubscription

module:caplin/sljsadapter/providers/StreamLinkSubscription

The StreamLinkSubscription class provides a StreamLinkJS transport implementation of the module:caplin/services/messaging/Subscription interface. Constructs an instance of StreamLinkSubscription.

Constructor

new module:caplin/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:
Throws:
if subject is undefined, null or empty
Type
module:br/Errors.InvalidParametersError

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:
Throws:
if the subscription has already been disposed of.
Type
module:br/Errors.IllegalStateError

getSubject()

Returns the subject that this subscription is subscribed to.
Implements:
Returns:
The subscribed subject.

isDisposed()

Checks whether the subscription has been disposed.
Implements:
Returns:
true if the subscription is disposed, otherwise false

isPaused()

Returns whether the subscription is currently paused or not.
Implements:
Throws:
if the subscription has been disposed of.
Type
module:br/Errors.IllegalStateError

pause()

Temporarily disables the subscription from receiving new updates to the subject.
Implements:
Throws:
if the subscription has been disposed of.
Type
module:br/Errors.IllegalStateError

resume()

Re-enables the subscription, allowing it to receive any new updates to the subject.
Implements:
Throws:
if the subscription has been disposed of.
Type
module:br/Errors.IllegalStateError