OpenMAMA
Wombat::MamdaOrderImbalanceHandler Class Reference

MamdaOrderImbalanceHandler is an interface for applications that want to have an easy way to handle order imbalance updates. More...

#include <MamdaOrderImbalanceHandler.h>

Public Member Functions

virtual void onOrderImbalance (MamdaSubscription *subscription, MamdaOrderImbalanceListener &listener, const MamaMsg &msg, MamdaOrderImbalanceRecap &imbalance, MamdaOrderImbalanceUpdate &update)=0
 Method invoked when a order imbalance is reported.
virtual void onNoOrderImbalance (MamdaSubscription *subscription, MamdaOrderImbalanceListener &listener, const MamaMsg &msg, MamdaOrderImbalanceRecap &imbalance, MamdaOrderImbalanceUpdate &update)=0
 Method invoked when a no order imbalance is reported.
virtual void onOrderImbalanceRecap (MamdaSubscription *subscription, MamdaOrderImbalanceListener &listener, const MamaMsg &msg, MamdaOrderImbalanceRecap &imbalance)=0
 Method invoked when the current order imbalance information is available.
virtual ~MamdaOrderImbalanceHandler ()

Detailed Description

MamdaOrderImbalanceHandler is an interface for applications that want to have an easy way to handle order imbalance updates.

The interface defines callback methods for different types of order-imbalance events:

Constructor & Destructor Documentation

virtual Wombat::MamdaOrderImbalanceHandler::~MamdaOrderImbalanceHandler ( )
virtual
{};

Member Function Documentation

virtual void Wombat::MamdaOrderImbalanceHandler::onOrderImbalance ( MamdaSubscription subscription,
MamdaOrderImbalanceListener listener,
const MamaMsg &  msg,
MamdaOrderImbalanceRecap imbalance,
MamdaOrderImbalanceUpdate update 
)
pure virtual

Method invoked when a order imbalance is reported.

Parameters
subscriptionThe subscription which received this update.
listenerThe listener which invoked this callback.
msgThe MamaMsg that triggered this invocation.
imbalanceProvides access to imbalance details
updateProvides access to update details
virtual void Wombat::MamdaOrderImbalanceHandler::onNoOrderImbalance ( MamdaSubscription subscription,
MamdaOrderImbalanceListener listener,
const MamaMsg &  msg,
MamdaOrderImbalanceRecap imbalance,
MamdaOrderImbalanceUpdate update 
)
pure virtual

Method invoked when a no order imbalance is reported.

Parameters
subscriptionThe subscription which received this update.
listenerThe listener which invoked this callback.
msgThe MamaMsg that triggered this invocation.
imbalanceProvides access to imbalance details
updateProvides access to update details
virtual void Wombat::MamdaOrderImbalanceHandler::onOrderImbalanceRecap ( MamdaSubscription subscription,
MamdaOrderImbalanceListener listener,
const MamaMsg &  msg,
MamdaOrderImbalanceRecap imbalance 
)
pure virtual

Method invoked when the current order imbalance information is available.

The reason for the invocation may be any of the following:

  • Initial image.
  • Recap update (e.g., after server fault tolerant event or data quality event.)
  • After stale status removed.
    Parameters
    subscriptionThe subscription which received this update
    listenerThe listener which invoked this callback
    msgThe MamaMsg that triggered this invocation
    imbalanceProvides access to imbalance details

The documentation for this class was generated from the following file:


© 2012 Linux Foundation