OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
Public Member Functions | List of all members
SessionScheduler Class Reference

#include <OnixS/B3/BOE/scheduling/SessionScheduler.h>

Public Member Functions

 SessionScheduler (const SessionSchedulerOptions &options)
 
 ~SessionScheduler ()
 
const SessionSchedule * findSchedule (const SessionScheduleId &id) const
 
const SessionConnectionSettings * findConnectionSettings (const SessionConnectionSettingsId &id) const
 
SessionScheduler & add (Session *session, const SessionSchedule &schedule, const SessionConnectionSettings &connection)
 
SessionScheduler & add (Session *session, const SessionScheduleId &scheduleId, const SessionConnectionSettingsId &connectionId)
 
SessionScheduler & remove (Session *session)
 
SessionScheduler & serviceThreadAffinity (const OnixS::B3::BOE::CpuIndexes &cpuIndexes)
 
const OnixS::B3::BOE::CpuIndexes & serviceThreadAffinity () const noexcept
 
SessionScheduler & reconnectAttempts (int value)
 
int reconnectAttempts () const
 
SessionScheduler & reconnectInterval (int value)
 
int reconnectInterval () const
 
SessionScheduler & utcTimeUsage (bool value)
 
bool utcTimeUsage () const
 

Detailed Description

Definition at line 92 of file SessionScheduler.h.

Constructor & Destructor Documentation

SessionScheduler ( const SessionSchedulerOptions &  options)
~SessionScheduler ( )

Performs the graceful shutdown of scheduling sessions.

Member Function Documentation

SessionScheduler& add ( Session *  session,
const SessionSchedule &  schedule,
const SessionConnectionSettings &  connection 
)

Adds the session to the automatic connection management.

  • If the session is being added during the active time frame, it will be connected immediately.
  • If the session is being registered during the inactive time frame and is in the active state, it will be disconnected.
  • If the session is already registered, an exception will be thrown.
Parameters
sessionthe instance of the session to be maintained.
scheduleSession's schedule.
connectionSession's connection settings.
SessionScheduler& add ( Session *  session,
const SessionScheduleId &  scheduleId,
const SessionConnectionSettingsId &  connectionId 
)

Adds the session to the automatic connection management.

  • If the session is being added during the active time frame, it will be connected immediately.
  • If the session is being registered during the inactive time frame and is in the active state, it will be disconnected.
  • If the session is already registered, and exception will be thrown.
Parameters
sessionthe instance of the session to be maintained.
scheduleIdthe ID of the predefined schedule.
connectionIdthe ID of the predefined connection settings.
const SessionConnectionSettings* findConnectionSettings ( const SessionConnectionSettingsId &  id) const

Looks for the predefined session connection settings associated with the given id that was specified in Scheduler's configuration file.

Returns
NULL if no settings are available for the given id.
const SessionSchedule* findSchedule ( const SessionScheduleId &  id) const

Looks for the predefined session schedule associated with the given id that was specified in Scheduler's configuration file.

Returns
NULL if no schedule is available for the given id.
SessionScheduler& reconnectAttempts ( int  value)

Sets the number of logon attempts in case of a logon failure.

int reconnectAttempts ( ) const
Returns
the number of logon attempts in case of a logon failure.

The default value is 3.

SessionScheduler& reconnectInterval ( int  value)

Sets the time interval between the logon attempts in case of a logon failure (in seconds).

int reconnectInterval ( ) const
Returns
the time interval between the logon attempts in case of a logon failure (in seconds).

The default value is 180 seconds.

SessionScheduler& remove ( Session *  session)

Removes the session from the automatic connection management services.

SessionScheduler& serviceThreadAffinity ( const OnixS::B3::BOE::CpuIndexes &  cpuIndexes)

Sets the CPU affinity for the Scheduler service thread.

const OnixS::B3::BOE::CpuIndexes& serviceThreadAffinity ( ) const
noexcept
Returns
the CPU affinity for the Scheduler service thread.
SessionScheduler& utcTimeUsage ( bool  value)

Activates the UTC usage.

bool utcTimeUsage ( ) const
Returns
true if the UTC is used, otherwise - false.

The default value is false.

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