com.dxfeed.api.osub

Interface ObservableSubscription<E>

Type Parameters:

E - the type of events.

All Known Implementing Classes:

DXFeedSubscription, DXFeedTimeSeriesSubscription

public interface ObservableSubscription<E>

Observable set of subscription symbols for the specific event type.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ObservableSubscriptionChangeListener listener) Adds subscription change listener.
boolean	containsEventType(Class<?> eventType) Returns true if this subscription contains the corresponding event type.
Set<Class<? extends E>>	getEventTypes() Returns a set of event types for this subscription.
boolean	isClosed() Returns true if this subscription is closed.
void	removeChangeListener(ObservableSubscriptionChangeListener listener) Removes subscription change listener.

Method Detail

isClosed

boolean isClosed()

Returns true if this subscription is closed. The observable subscription that is returned as a result of DXPublisher.getSubscription is closed when the corresponding DXEndpoint is closed.

getEventTypes

Set<Class<? extends E>> getEventTypes()

Returns a set of event types for this subscription. The resulting set cannot be modified. The observable subscription that is returned as a result of DXPublisher.getSubscription has a singleton set of event types.

containsEventType

boolean containsEventType(Class<?> eventType)

Returns true if this subscription contains the corresponding event type.

See Also:

getEventTypes()

addChangeListener

void addChangeListener(ObservableSubscriptionChangeListener listener)

Adds subscription change listener. This method does nothing if the given listener is already installed as subscription change listener for this subscription or if subscription is closed. Otherwise, it installs the corresponding listener and immediately invokes ObservableSubscriptionChangeListener.symbolsAdded(java.util.Set<?>) on the given listener while holding the lock for this subscription. This way the given listener synchronously receives existing subscription state and and is synchronously notified on all changes in subscription afterwards.

Parameters:

listener - the subscription change listener.

Throws:

NullPointerException - if listener is null.

removeChangeListener

void removeChangeListener(ObservableSubscriptionChangeListener listener)

Removes subscription change listener. This method does nothing if the given listener was not installed or was already removed as subscription change listener for this subscription. Otherwise it removes the corresponding listener and immediately invokes ObservableSubscriptionChangeListener.subscriptionClosed() on the given listener while holding the lock for this subscription.

Parameters:

listener - the subscription change listener.

Throws:

NullPointerException - if listener is null.