Caplin Trader 5.1.0

Interface: module:ct-services/messaging/Subscription

module:ct-services/messaging/Subscription

Represents a subscription made with an implementation of ct-services/messaging/MessageService.

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.

Throws:

if the subscription has already been disposed of.

getSubject()

Returns the subject that this subscription is subscribed to.

isDisposed()

Checks whether the subscription has been disposed.

Returns:

true if the subscription is disposed, otherwise false

isPaused()

Returns whether the subscription is currently paused or not.

Throws:

if the subscription has been disposed of.

pause()

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

Throws:

if the subscription has been disposed of.

resume()

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

Throws:

if the subscription has been disposed of.