OnixS C++ CME iLink 3 Binary Order Entry Handler  1.18.0
API Documentation
SessionSchedulerListener Class Referenceabstract

#include <OnixS/CME/iLink3/scheduling/SessionScheduler.h>

Public Member Functions

virtual void onLoggingOut (const SessionScheduler &scheduler, Session *session, bool *allowLogout)=0
 
virtual void onWarning (const SessionScheduler &scheduler, Session *session, const std::string &warningReason)=0
 
virtual void onError (const SessionScheduler &scheduler, Session *session, const std::string &errorReason)=0
 

Protected Member Functions

virtual ~SessionSchedulerListener ()=default
 

Detailed Description

Definition at line 42 of file SessionScheduler.h.

Constructor & Destructor Documentation

virtual ~SessionSchedulerListener ( )
protectedvirtualdefault

Member Function Documentation

virtual void onError ( const SessionScheduler scheduler,
Session session,
const std::string &  errorReason 
)
pure virtual

Notifies about an error.

virtual void onLoggingOut ( const SessionScheduler scheduler,
Session session,
bool *  allowLogout 
)
pure virtual

Notifies that the session is about to be closed.

Parameters
schedulerthe instance the of session scheduler that is about to close the session.
sessionthe session that is about to be closed.
allowLogoutindicates whether the scheduler must perform the logout. To prohibit the logout set this parameter to false.
virtual void onWarning ( const SessionScheduler scheduler,
Session session,
const std::string &  warningReason 
)
pure virtual

Notifies about a non-critical issue.


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