com.apama.position.tracker
Event PSTrackerInterface


This callback interface is implemented by the Position Tracker object itself, to be called by the Position Manager Service when it needs the Tracker implementation to create or delete an instance of a Position Tracker.

This callback interface is provided by the User application when it registers a Position Tracker with the Position Service.

The actual implementation of this interface is Position Tracker dependent.
Member summary
 action<integer, integer, com.apama.position.PositionConfigParams, action<integer, integer, boolean, string>>createInstance

This action will be called when the Position Service Manager needs to create a new instance of a Position Tracker that has been registered with it.
 action<integer, integer, action<integer, integer, boolean, string>>deleteInstance

This action will be called when the Position Service Manager needs to delete an instance of the Position Tracker.
 action<action<boolean, string>>deleteAllInstances

This action will be called when the Position Service Manager needs to delete all instances of the Position Tracker.
 action<integer, integer, com.apama.position.Position, boolean, com.apama.position.PositionConfigParams, action<integer, integer, boolean, boolean, string>>positionExternallyUpdated

This action will be called when a Subscription Manager Interface requests that a subscriptions position should be adjusted, either by an absolute or relative amount.
 action<integer, integer, action<integer, integer, boolean, string>>positionExternallyReset

This action will be called when a Subscription Manager Interface requests that a subscriptions position should be reset to zero.
 action<integer, integer, string, action<integer, integer, string, boolean, string, com.apama.position.Position, integer>>subscribeSymbolSliceUpdates

This action will be called when a Subscription Manager Interface requests a subscription to a symbol slice.
 action<integer, integer, string, action<integer, integer, string, boolean, string>>unsubscribeSymbolSliceUpdates

This action will be called when a Subscription Manager Interface requests an unsubscription to a symbol slice. The subscription requests should be reference counted and updates no longer published when the count is zero.
 
Member detail

createInstance

action<integer, integer, com.apama.position.PositionConfigParams, action<integer, integer, boolean, string>> createInstance
This action will be called when the Position Service Manager needs to create a new instance of a Position Tracker that has been registered with it.

A unique subscription ID is provided for this instance, however, if the Position Tracker implementation decides that an existing instance already exists that matches this creation request, the subscriptionId of the existing instance should be returned in the created callback.


param requestId A unique requestId that must be used when the completion callback is called
param subscriptionId The subscription ID for this Position Tracker instance.
param config A PositionConfigParams object containing any configuration information for this Position Tracker
param cbCreated This callback must be called by the Position Tracker implementation after it has completed the creation of the Position Tracker instance. This allows the creation of the Position Tracker instance to be asynchronous

deleteAllInstances

action<action<boolean, string>> deleteAllInstances
This action will be called when the Position Service Manager needs to delete all instances of the Position Tracker.


param cbAllDeleted This callback must be called by the Position Tracker implementation after it has completed the deletion of all the Position Tracker instances. This allows the deletion of the Position Tracker instances to be asynchronous

deleteInstance

action<integer, integer, action<integer, integer, boolean, string>> deleteInstance
This action will be called when the Position Service Manager needs to delete an instance of the Position Tracker.


param requestId A unique requestId that must be used when the completion callback is called
param subscriptionId The subscription ID for the Position Tracker instance to delete
param cbDeleted This callback must be called by the Position Tracker implementation after it has completed the deletion of the Position Tracker instance. This allows the deletion of the Position Tracker instance to be asynchronous

positionExternallyReset

action<integer, integer, action<integer, integer, boolean, string>> positionExternallyReset
This action will be called when a Subscription Manager Interface requests that a subscriptions position should be reset to zero.


param requestId The unique identifier for the request to adjust a subscriptions position
param subscriptionId The identifier of the subscription whose position should be updated
param cbResetComplete This callback must be called by the Position Tracker implementation after it has reset the position

positionExternallyUpdated

action<integer, integer, com.apama.position.Position, boolean, com.apama.position.PositionConfigParams, action<integer, integer, boolean, boolean, string>> positionExternallyUpdated
This action will be called when a Subscription Manager Interface requests that a subscriptions position should be adjusted, either by an absolute or relative amount.


param requestId The unique identifier for the request to adjust a subscriptions position
param subscriptionId The identifier of the subscription whose position should be updated
param adjustment The position adjustment to be made
param relative Indicates whether or not this is a relative or absolute adjustment
param config Any extra configuration that may be required by a specific Position Tracker for the adjustment
param cbAdjustedPosition This callback must be called by the Position Tracker implementation after it has completed making the position adjustment

subscribeSymbolSliceUpdates

action<integer, integer, string, action<integer, integer, string, boolean, string, com.apama.position.Position, integer>> subscribeSymbolSliceUpdates
This action will be called when a Subscription Manager Interface requests a subscription to a symbol slice.

These requests must be reference counted by the tracker, and duplicate subscriptions should use the same updateRefId. The tracker should then call publishSymbolSlicePosition() when the requests Symbol Slice has been updated.


param requestId The unique identifier for the subscription request to a symbol slice
param subscriptionId The identifier of the subscription whose symbol slice the subscription is for
param symbolSlice The symbol slice the subscription is for
param cbSubscriptionComplete This callback must be called by the Position Tracker implementation after the symbol slice subscription is complete
See Also:
com.apama.position.tracker.PSTrackerManagerInterface#publishSymbolSlicePosition - The action to call on a Symbol Slice position update
unsubscribeSymbolSliceUpdates - 

unsubscribeSymbolSliceUpdates

action<integer, integer, string, action<integer, integer, string, boolean, string>> unsubscribeSymbolSliceUpdates
This action will be called when a Subscription Manager Interface requests an unsubscription to a symbol slice. The subscription requests should be reference counted and updates no longer published when the count is zero.


param requestId The unique identifier for the unsubscription request
param subscriptionId The identifier of the subscription whose symbol slice the unsubscription is for
param symbolSlice The symbol slice the unsubscription is for
param cbUnsubscriptionComplete This callback must be called by the Position Tracker implementation after the symbol slice unsubscription is complete
See Also:
subscribeSymbolSliceUpdates -