Package deltix.qsrv.hf.tickdb.pub.query

Interface EntitySubscriptionController

All Known Subinterfaces:

EntityAndTypeSubscriptionController, InstrumentMessageSource, SubscriptionController, SubscriptionManager, SymbolAndTypeSubscriptionController, SymbolAndTypeSubscriptionControllerAdapter, SymbolAndTypeSubscriptionControllerClient, SymbolSubscriptionController, TickCursor

All Known Implementing Classes:

InstrumentMessageSourceAdapter, LimitedInstrumentMessageSource, MessageReader2, SubscriptionManagerWrapper, TickCursorAdapter, TickCursorClientAeron

public interface EntitySubscriptionController

Controls subscription for a number of entities. Methods have no return value, because they can act asynchronously. The implementor of this interface is not required to remember the subscription details; therefore, there are no methods provided to query the current state (such as "hasEntity", etc.). The user of this interface can independently track current subscription, if so desired.

Method Summary

Modifier and Type	Method	Description
default void	addEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids)
void	addEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids, int offset, int length)	Bulk add the specified entities to subscription.
void	addEntity(deltix.qsrv.hf.pub.InstrumentIdentity id)	Add the specified entity to subscription.
void	clearAllEntities()	Switch to selective subscription mode (if necessary) and clear the list.
default void	removeEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids)
void	removeEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids, int offset, int length)	Remove the specified entities from subscription.
void	removeEntity(deltix.qsrv.hf.pub.InstrumentIdentity id)	Remove the specified entity from subscription.
void	subscribeToAllEntities()	Subscribe to all available entities.

Method Detail

subscribeToAllEntities

void subscribeToAllEntities()

Subscribe to all available entities.

clearAllEntities

void clearAllEntities()

Switch to selective subscription mode (if necessary) and clear the list.

addEntity

void addEntity(deltix.qsrv.hf.pub.InstrumentIdentity id)

Add the specified entity to subscription. The type and symbol are copied from the incoming object, if necessary, so the argument can be re-used after the call. Special note about options: The following fragment will subscribe to specific option contract "DAV 100417P00085000": addEntity(new InstrumentKey(InstrumentType.OPTION, "DAV 100417P00085000")); While the following will subscribe to option root (and you will get all instruments with this root): addEntity(new InstrumentKey(InstrumentType.OPTION, "DAV "));

addEntities

void addEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids,
                 int offset,
                 int length)

Bulk add the specified entities to subscription. The type and symbol are copied from the incoming objects, if necessary, so the arguments can be re-used after the call.

addEntities

default void addEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids)

removeEntity

void removeEntity(deltix.qsrv.hf.pub.InstrumentIdentity id)

Remove the specified entity from subscription. The type and symbol are copied from the incoming object, if necessary, so the argument can be re-used after the call.

removeEntities

void removeEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids,
                    int offset,
                    int length)

Remove the specified entities from subscription. The type and symbol are copied from the incoming objects, if necessary, so the arguments can be re-used after the call.

removeEntities

default void removeEntities(deltix.qsrv.hf.pub.InstrumentIdentity[] ids)