OnixS C++ FIX Engine  4.2.0
API Documentation
SessionSchedule Class Reference

#include <OnixS/FIXEngine/FIX/Scheduling/SessionSchedule.h>

Public Member Functions

 SessionSchedule (DayOfWeek::Enum firstDay, DayOfWeek::Enum lastDay, TimeOfDay logonTime, TimeOfDay logoutTime, SessionDuration::Enum sessionDuration, SequenceNumberResetPolicy::Enum seqNumberResetPolicy)
 
 SessionSchedule (const SessionSchedule &other)
 
TimeOfDay logonTime (DayOfWeek::Enum day) const
 
void logonTime (DayOfWeek::Enum day, TimeOfDay time)
 
TimeOfDay logoutTime (DayOfWeek::Enum day) const
 
void logoutTime (DayOfWeek::Enum day, TimeOfDay time)
 
SessionDuration::Enum sessionDuration () const
 
SequenceNumberResetPolicy::Enum sequenceNumberResetPolicy () const
 
DayOfWeek::Enum sequenceNumberWeeklyResetDay () const
 
SessionScheduleoperator= (const SessionSchedule &other)
 

Friends

class SessionStateChanger
 

Detailed Description

Also provides the ability to define sequence number reset policy for the session.

Definition at line 200 of file SessionSchedule.h.

Constructor & Destructor Documentation

SessionSchedule ( DayOfWeek::Enum  firstDay,
DayOfWeek::Enum  lastDay,
TimeOfDay  logonTime,
TimeOfDay  logoutTime,
SessionDuration::Enum  sessionDuration,
SequenceNumberResetPolicy::Enum  seqNumberResetPolicy 
)

Initializes session schedule according to given parameters.

If session duration is single day, then logon and logout performed each day from the first day of week till the last day of week. Is session duration is defined as entire week then session logon occurs on the first day of week and corresponding logout performed on the last day of week.

Session sequence number reset policy must correspond to the session duration time. In particular, if session continues entire week it's not possible to request scheduler to reset session sequence number on daily basis.

Parameters
firstDayDefines first day of activity week for the session.
lastDayDefines last day of activity week for the session.
logonTimeDefines time of logon for session for each activity day if session duration is single day. If session must continue entire week, defines time of logon performed on the first day of activity week.
logoutTimeDefines time of logout for session for each activity day if session duration is single day. If session must continue entire week, defines time of logout performed on the last day of activity week.
sessionDurationDefines whether session continues entire week or activity time frame is limited for single day.
seqNumberResetPolicyDefines session sequence number reset policy.
SessionSchedule ( const SessionSchedule other)

Initializes clone of the given instance.

Member Function Documentation

TimeOfDay logonTime ( DayOfWeek::Enum  day) const
inline

Logon time for the session for given day.

If logon is not performed on given day, returned value correspondent equals to TimeOfDay::bad() value.

Definition at line 296 of file SessionSchedule.h.

void logonTime ( DayOfWeek::Enum  day,
TimeOfDay  time 
)
inline

Defines logon time for the session for given day.

If logon is not performed on given day, returned value correspondent equals to TimeOfDay::bad() value.

Definition at line 303 of file SessionSchedule.h.

TimeOfDay logoutTime ( DayOfWeek::Enum  day) const
inline

Logout time for the session for given day.

If logout is not performed on given day, returned value correspondent equals to TimeOfDay::bad() value.

Definition at line 311 of file SessionSchedule.h.

void logoutTime ( DayOfWeek::Enum  day,
TimeOfDay  time 
)
inline

Defines logout time for the session for given day.

If logout is not performed on given day, returned value correspondent equals to TimeOfDay::bad() value.

Definition at line 318 of file SessionSchedule.h.

SessionSchedule& operator= ( const SessionSchedule other)

Reinitializes the instance from the other one.

SequenceNumberResetPolicy::Enum sequenceNumberResetPolicy ( ) const
inline

Defines session sequence number reset policy.

Definition at line 333 of file SessionSchedule.h.

DayOfWeek::Enum sequenceNumberWeeklyResetDay ( ) const
inline

Day of week on which session message sequence numbers are reset.

Definition at line 340 of file SessionSchedule.h.

SessionDuration::Enum sessionDuration ( ) const
inline

Defines whether session continues entire week or activity time frame is limited for single day.

Definition at line 326 of file SessionSchedule.h.

Friends And Related Function Documentation

friend class SessionStateChanger
friend

Definition at line 283 of file SessionSchedule.h.


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