com.apama.md.user
Event QuotebookManager


The Quotebook Manager event is used for simplifying the use of the Market data interface for handling the Quotebook data stream information.
Since:
CMF 5.0.1

Action Summary
 integeraddQuotebookUpdateCallback(com.apama.md.adapter.ConnectionKey connKey, action<com.apama.md.client.CurrentQuotebookInterface > userOnAllQuotebook)

This function is called by the user to register an update callback function for a specific symbol.
 voidconnect(string symbol, com.apama.session.CtrlParams controlParams, action<com.apama.session.SessionError > userOnSessionError, action<com.apama.md.adapter.ConnectionKey > userOnConnectSuccess, action<com.apama.md.adapter.ConnectionKeycom.apama.md.client.Error > userOnConnectFailure)

This function is called by the user to connect to a previously created data stream interface for a specific symbol.
 voidconnectWithoutCache(string symbol, com.apama.session.CtrlParams controlParams, action<com.apama.session.SessionError > userOnSessionError, action<com.apama.md.adapter.ConnectionKey > userOnConnectSuccess, action<com.apama.md.adapter.ConnectionKeycom.apama.md.client.Error > userOnConnectFailure)

This function is called by the user to connect to a previously created data stream interface for a specific symbol.
 voiddisconnect(com.apama.md.adapter.ConnectionKey connKey, action<com.apama.md.adapter.ConnectionKey > success, action<com.apama.md.adapter.ConnectionKeycom.apama.md.client.Error > failure)

This function is called by the user to disconnect a specific symbol from the data stream.
 sequence<com.apama.md.adapter.ConnectionKey >getConnectionList()

Helper function to return a sequence of the current connection keys.
 sequence<com.apama.md.adapter.ConnectionKey >getConnectionListForSymbol(string symbol)

Helper function to return a sequence of the potential connection keys for any connections with a specified symbol name.
 com.apama.session.CtrlParamsSchemagetCtrlParamSchema()

Helper function to provide access to the control parameters for this data stream.
 com.apama.md.client.CurrentQuotebookInterfacegetCurrentQuotebook(com.apama.md.adapter.ConnectionKey connKey)

Helper function to return the last Quotebook snapshot that was received.
 booleanhasData(com.apama.md.adapter.ConnectionKey connKey)

Helper function to determine whether any data has been received yet.
 booleanremoveQuotebookCallback(com.apama.md.adapter.ConnectionKey connKey, integer reference)

This function is called by the user to remove an update callback based on the reference that was returned when it was added.
 integerrequestQuotebook(com.apama.md.adapter.ConnectionKey connKey)

Helper function to return the current Quotebook interface.
 
Action Detail

addQuotebookUpdateCallback

integer addQuotebookUpdateCallback(com.apama.md.adapter.ConnectionKey connKey, action<com.apama.md.client.CurrentQuotebookInterface > userOnAllQuotebook)
This function is called by the user to register an update callback function for a specific symbol.

The callback function returns a reference to the current Quotebook interface rather than the data itself. This means that if you store the returned CurrentQuotebookInterface reference and attempt to use it after a series of updates, the stored CurrentQuotebookInterface will refer to the last update.
Parameters:
connKey - The unique key for the connection to the datastream to register the update callback for.
userOnAllQuotebook - A callback action called when new Quotebook updates are received.
Returns:
An integer reference ID which can be used to unregister the update callback.
See Also:
#removeQuotebookCallback - This function should be called to remove the update handler given the reference Id returned from this function.

connect

void connect(string symbol, com.apama.session.CtrlParams controlParams, action<com.apama.session.SessionError > userOnSessionError, action<com.apama.md.adapter.ConnectionKey > userOnConnectSuccess, action<com.apama.md.adapter.ConnectionKeycom.apama.md.client.Error > userOnConnectFailure)
This function is called by the user to connect to a previously created data stream interface for a specific symbol.
Parameters:
symbol - The symbol to connect to.
controlParams - Control parameters (if required).
userOnSessionError - Callback action for session errors.
userOnConnectSuccess - A callback action on successful connection to the datastream.
userOnConnectFailure - A callback action on failure to connect to the datastream.

connectWithoutCache

void connectWithoutCache(string symbol, com.apama.session.CtrlParams controlParams, action<com.apama.session.SessionError > userOnSessionError, action<com.apama.md.adapter.ConnectionKey > userOnConnectSuccess, action<com.apama.md.adapter.ConnectionKeycom.apama.md.client.Error > userOnConnectFailure)
This function is called by the user to connect to a previously created data stream interface for a specific symbol.
Parameters:
symbol - The symbol to connect to.
controlParams - Control parameters (if required).
userOnSessionError - Callback action for session errors.
userOnConnectSuccess - A callback action on successful connection to the datastream.
userOnConnectFailure - A callback action on failure to connect to the datastream.

disconnect

void disconnect(com.apama.md.adapter.ConnectionKey connKey, action<com.apama.md.adapter.ConnectionKey > success, action<com.apama.md.adapter.ConnectionKeycom.apama.md.client.Error > failure)
This function is called by the user to disconnect a specific symbol from the data stream.
Parameters:
connKey - The unique key for the connection to the datastream that we want to disconnect.
success - A callback action on successful disconnection from the datastream.
failure - A callback action on failure to disconnect from to the datastream.

getConnectionList

sequence<com.apama.md.adapter.ConnectionKey > getConnectionList()
Helper function to return a sequence of the current connection keys.
Returns:
A sequence of the current connection keys.

getConnectionListForSymbol

sequence<com.apama.md.adapter.ConnectionKey > getConnectionListForSymbol(string symbol)
Helper function to return a sequence of the potential connection keys for any connections with a specified symbol name.
Parameters:
symbol - The symbol to get the connection list for.
Returns:
A sequence of the potential connection keys for any connections with a specified symbol name.

getCtrlParamSchema

com.apama.session.CtrlParamsSchema getCtrlParamSchema()
Helper function to provide access to the control parameters for this data stream.
Returns:
Event for the Quotebook datastream.

getCurrentQuotebook

com.apama.md.client.CurrentQuotebookInterface getCurrentQuotebook(com.apama.md.adapter.ConnectionKey connKey)
Helper function to return the last Quotebook snapshot that was received.
Parameters:
connKey - The unique key for the connection to the datastream to request the current data for.
Returns:
The last snapshot that was received.

hasData

boolean hasData(com.apama.md.adapter.ConnectionKey connKey)
Helper function to determine whether any data has been received yet.
Parameters:
connKey - The unique key for the connection to the datastream to check data exists for.
Returns:
true if data is available, false otherwise.

removeQuotebookCallback

boolean removeQuotebookCallback(com.apama.md.adapter.ConnectionKey connKey, integer reference)
This function is called by the user to remove an update callback based on the reference that was returned when it was added.
Parameters:
connKey - The unique key for the connection to the datastream to register the update callback for.
reference - The Reference ID returned from addQuotebookUpdateCallback.
Returns:
true if successful, false otherwise.
See Also:
#addQuotebookUpdateCallback - The function that provides the reference Id.

requestQuotebook

integer requestQuotebook(com.apama.md.adapter.ConnectionKey connKey)
Helper function to return the current Quotebook interface.
Parameters:
connKey - The unique key for the connection to the datastream to request a Quotebook for.
Returns:
The current Quotebook interface.