velox.api.layer1.simplified

Interface CustomModule

All Known Subinterfaces:

AllDataModule, CustomModuleAdapter

public interface CustomModule

Must be implemented by modules annotated with Layer1SimpleAttachable. Provides way for Bookmap to interact with module.

Method Summary

Modifier and Type	Method and Description
void	initialize(java.lang.String alias, InstrumentInfo info, Api api, InitialState initialState) Called before any other method
void	stop() Called before unloading the module.

Method Detail

initialize

void initialize(java.lang.String alias,
                InstrumentInfo info,
                Api api,
                InitialState initialState)

Called before any other method

Parameters:

alias - host instrument (the one where checkbox was checked)

info - instrument info. Might be an instance of a subclass, providing some extra data

api - object for interacting with Bookmap

initialState - additional information partially replacing historical data, such as last trade price

stop

void stop()

Called before unloading the module. If you have started any thread or allocated any resources - that's a good place to release those.