Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.services.messaging

Subscription

Represents a subscription made with an implementation of caplin.services.messaging.MessageService.

Constructor Summary

Attributes Name and Description
caplin.services.messaging.Subscription()

Method Summary

Attributes Name and Description
void dispose()

Permanently stops the subscription from receiving new updates to the subject.
String getSubject()

Returns the subject that this subscription is subscribed to.
Boolean isPaused()

Returns whether the subscription is currently paused or not.
void pause()

Temporarily disables the subscription from receiving new updates to the subject.
void resume()

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

Constructor Detail

► caplin.services.messaging.Subscription()

Method Detail

► void 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
caplin.core.Error
if the subscription has already been disposed of.

► String getSubject()

Returns the subject that this subscription is subscribed to.

► Boolean isPaused()

Returns whether the subscription is currently paused or not.

Throws
caplin.core.Error
if the subscription has been disposed of.

► void pause()

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

Throws
caplin.core.Error
if the subscription has been disposed of.

► void resume()

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

Throws
caplin.core.Error
if the subscription has been disposed of.