com.apama.md.user
Event DepthManager


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

Action summary
 integeraddDepthUpdateCallback(com.apama.md.adapter.ConnectionKey connKey, action<com.apama.md.client.CurrentDepthInterface> userOnAllDepth)

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.CurrentDepthInterfacegetCurrentDepth(com.apama.md.adapter.ConnectionKey connKey)

Helper function to return the current Depth interface.
 booleanhasData(com.apama.md.adapter.ConnectionKey connKey)

Helper function to determine whether any data has been received yet.
 booleanremoveDepthCallback(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.
 
Action detail

addDepthUpdateCallback

            integer addDepthUpdateCallback(com.apama.md.adapter.ConnectionKey connKey, action<com.apama.md.client.CurrentDepthInterface> userOnAllDepth)
        
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 Depth interface rather than the data itself. This means that if you store the returned CurrentDepthInterface reference and attempt to use it after a series of updates, the stored CurrentDepthInterface will refer to the last update.
Parameters:
connKey - The unique key for the connection to the datastream to register the update callback for.
userOnAllDepth - A callback action called when new Depth updates are received.
Returns:
An integer reference ID which can be used to unregister the update callback.
Since:
CMF 2.0.0
See Also:
#removeDepthCallback - 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.
Since:
CMF 2.0.0

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.
Since:
CMF 2.0.0

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.
Since:
CMF 2.0.0

getConnectionList

            sequence<com.apama.md.adapter.ConnectionKeygetConnectionList()
        
Helper function to return a sequence of the current connection keys.
Returns:
A sequence of the current connection keys.
Since:
CMF 2.2.0

getConnectionListForSymbol

            sequence<com.apama.md.adapter.ConnectionKeygetConnectionListForSymbol(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.
Since:
CMF 2.2.0

getCtrlParamSchema

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

getCurrentDepth

            com.apama.md.client.CurrentDepthInterface getCurrentDepth(com.apama.md.adapter.ConnectionKey connKey)
        
Helper function to return the current Depth interface.
Parameters:
connKey - The unique key for the connection to the datastream to request the current data for.
Returns:
The current Depth interface.
Since:
CMF 2.0.0

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.
Since:
CMF 2.2.0

removeDepthCallback

            boolean removeDepthCallback(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 remove the update callback for.
reference - The Reference ID returned from addDepthUpdateCallback.
Returns:
true if successful, false otherwise.
Since:
CMF 2.0.0
See Also:
#addDepthUpdateCallback - The function that provides the reference Id.