com.caplin.streamlink

Interface Subscription

public interface Subscription

Represents a subscription to a subject on the Liberator.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getSubject() Returns the subject name to which the subscription relates (for example, /FX/EURUSD).
SubscriptionListener	getSubscriptionListener() Returns the SubscriptionListener that is informed of all subscription events relating to this subscription.
void	setContainerWindow(int start, int size) Sets the container window for this subscription.
void	unsubscribe() Unsubscribes to the subject on the Liberator.

Method Detail

getSubject

java.lang.String getSubject()

Returns the subject name to which the subscription relates (for example, /FX/EURUSD).

Returns:

The subject of this subscription.

getSubscriptionListener

SubscriptionListener getSubscriptionListener()

Returns the SubscriptionListener that is informed of all subscription events relating to this subscription.

Returns:

The subscription listener.

unsubscribe

void unsubscribe()

Unsubscribes to the subject on the Liberator.

setContainerWindow

void setContainerWindow(int start,
                      int size)

Sets the container window for this subscription.

If the subject type of this subscription is not a container then this method will throw an exception.

Note: A container element is referred to by its index within the container. The first element of a container has index 0 (zero).

Parameters:

start - The index of the container element that is at the start of the container window.

size - The number of elements in the container window.