OnixS C++ ICE Binary Order Entry Handler 1.1.2
API Documentation
Loading...
Searching...
No Matches
SessionSchedulerListener Class Referenceabstract

Public Member Functions

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

Protected Member Functions

virtual ~SessionSchedulerListener ()=0

Detailed Description

Definition at line 44 of file SessionScheduler.h.

Constructor & Destructor Documentation

◆ ~SessionSchedulerListener()

virtual ~SessionSchedulerListener ( )
protectedpure virtual

Member Function Documentation

◆ onError()

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

Notifies about an error.

Parameters
schedulerthe instance the of session scheduler that fires the error.
sessionthe session that that fires the error.
errorReasonthe error reason text.

Reimplemented in SchedulingIssueDetector.

Definition at line 67 of file SessionScheduler.h.

◆ onLoggingOut()

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

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.

Definition at line 53 of file SessionScheduler.h.

◆ onWarning()

virtual void onWarning ( const SessionScheduler & scheduler,
Session * session,
const std::string & warningReason )
inlinevirtual

Notifies about a non-critical issue.

Parameters
schedulerthe instance the of session scheduler that fires the warning.
sessionthe session that that fires the warning.
warningReasonthe warning reason text.

Reimplemented in SchedulingIssueDetector.

Definition at line 60 of file SessionScheduler.h.