SessionSchedule.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/

#pragma once

#include <string>
#include <vector>

#include <OnixS/FIXEngine/ABI.h>

#if !defined (MINMAX_ABUSER)
#define UNDEF_MINMAX_ABUSER
#define MINMAX_ABUSER
#endif

namespace OnixS {
namespace FIX {
namespace Scheduling {
/// Specifies activity time frame for the session.
struct
    ONIXS_FIXENGINE_API
    SessionDuration {
    enum Enum {
        /// Session continues not more than 24 hours.
        /// That is session logon and logout are
        /// performed within bounds of single day.
        Day,

        /// Session logon/logout occurs only once per week.
        Week
    };

    /// Transforms string presentation into valid constant.
    static Enum parse(const std::string & value);

    /// Builds string presentation for a given constant.
    static std::string toString(Enum value);
};

/// Defines session sequence number reset policy.
struct
    ONIXS_FIXENGINE_API
    SequenceNumberResetPolicy {
    enum Enum {
        /// Session sequence number must never
        /// be reset by scheduling services.
        Never,

        /// Session sequence number reset
        /// is performed on daily basis.
        Daily,

        /// Session sequence number reset
        /// is performed once per week.
        Weekly
    };

    /// Transforms string presentation into valid constant.
    static Enum parse(const std::string & value);

    /// Builds string presentation for a given constant.
    static std::string toString(Enum value);
};

/// Specifies day of the week.
struct
    ONIXS_FIXENGINE_API
    DayOfWeek {
    enum Enum {
        Sunday,
        Monday,
        Tuesday,
        Wednesday,
        Thursday,
        Friday,
        Saturday,
        Total
    };

    /// Transforms string presentation into valid constant.
    static Enum parse(const std::string & value);

    /// Builds string presentation for a given constant.
    static std::string toString(Enum value);
};

// Alias of the number of hours.
typedef int Hours;

// Alias of the number of minutes.
typedef int Minutes;

// Alias of the number of seconds.
typedef int Seconds;

/// Represents time of day.
class ONIXS_FIXENGINE_API TimeOfDay
{
public:
    /// Default initialization.
    TimeOfDay();

    /// Initializes instance to a specified
    /// number of hours, minutes, and seconds.
    TimeOfDay(
        Hours hours,
        Minutes minutes,
        Seconds = 0);

    /// Initializes from the other instance.
    TimeOfDay(const TimeOfDay &);

    /// Gets hours of the time of day.
    Hours hours() const;

    /// Gets minutes of the time of day.
    Minutes minutes() const;

    /// Gets seconds component of the time of day.
    Seconds seconds() const;

    /// Gets total number of seconds since the midnight.
    Seconds sinceMidnight() const;

    /// Builds string presentation.
    std::string toString() const;

    /// Checks whether the instance is equal to the other one.
    bool operator == (const TimeOfDay & other) const;

    /// Checks whether the instance is unequal to the other one.
    bool operator != (const TimeOfDay & other) const;

    // Reinitializes the instance from the other one.
    TimeOfDay & operator = (const TimeOfDay &);

    /// Returns current time of day value.
    static TimeOfDay now();

    /// 'Zero' point of the time of day.
    static TimeOfDay midnight();

    /// Instance of ill-formed time of day.
    static TimeOfDay bad();

    /// Parses time of day from its string presentation.
    static TimeOfDay parse(const std::string &);

private:
    Seconds seconds_;

    TimeOfDay(Seconds);
};

inline
Seconds
TimeOfDay::sinceMidnight() const
{
    return seconds_;
}

inline
bool
TimeOfDay::operator == (
    const TimeOfDay & other) const
{
    return seconds_ == other.seconds_;
}

inline
bool
TimeOfDay::operator != (
    const TimeOfDay & other) const
{
    return seconds_ != other.seconds_;
}

/// Collection of time of day values indexed by day of week.
typedef TimeOfDay TimeOfDayOfWeek[DayOfWeek::Total];

/// Defines activity time frames for the session.
/// Also provides the ability to define sequence number
/// reset policy for the session.
class ONIXS_FIXENGINE_API SessionSchedule
{
public:
    /// 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.
    ///
    /// @param firstDay Defines first day of activity week for the session.
    ///
    /// @param lastDay Defines last day of activity week for the session.
    ///
    /// @param logonTime Defines 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.
    ///
    /// @param logoutTime Defines 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.
    ///
    /// @param sessionDuration Defines whether session continues
    /// entire week or activity time frame is limited for single day.
    ///
    /// @param seqNumberResetPolicy Defines session sequence number reset policy.
    SessionSchedule(
        DayOfWeek::Enum firstDay,
        DayOfWeek::Enum lastDay,
        TimeOfDay logonTime,
        TimeOfDay logoutTime,
        SessionDuration::Enum sessionDuration,
        SequenceNumberResetPolicy::Enum seqNumberResetPolicy);

    /// Initializes clone of the given instance.
    SessionSchedule(const SessionSchedule & other);

    /// Logon time for the session for given day.
    ///
    /// If logon is  not performed on given day, returned
    /// value correspondent equals to TimeOfDay::bad() value.
    TimeOfDay logonTime(DayOfWeek::Enum day) const;

    /// 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.
    void logonTime(DayOfWeek::Enum day, TimeOfDay time);

    /// Logout time for the session for given day.
    ///
    /// If logout is  not performed on given day, returned
    /// value correspondent equals to TimeOfDay::bad() value.
    TimeOfDay logoutTime(DayOfWeek::Enum day) const;

    /// 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.
    void logoutTime(DayOfWeek::Enum day, TimeOfDay time);

    /// Defines whether session continues entire week
    /// or activity time frame is limited for single day.
    SessionDuration::Enum sessionDuration() const;

    /// Defines session sequence number reset policy.
    SequenceNumberResetPolicy::Enum sequenceNumberResetPolicy() const;

    /// Day of week on which session message sequence numbers are reset.
    DayOfWeek::Enum sequenceNumberWeeklyResetDay() const;

    /// Reinitializes the instance from the other one.
    SessionSchedule & operator = (const SessionSchedule & other);

private:
    friend class SessionStateChanger;

    TimeOfDayOfWeek logonTimes_;
    TimeOfDayOfWeek logoutTimes_;

    SessionDuration::Enum sessionDuration_;
    SequenceNumberResetPolicy::Enum seqNumberResetPolicy_;

    DayOfWeek::Enum startOfWeek_;
};

inline
TimeOfDay
SessionSchedule::logonTime(DayOfWeek::Enum day) const
{
    return logonTimes_[day];
}

inline
void
SessionSchedule::logonTime(
    DayOfWeek::Enum day, TimeOfDay logonTime)
{
    logonTimes_[day] = logonTime;
}

inline
TimeOfDay
SessionSchedule::logoutTime(DayOfWeek::Enum day) const
{
    return logoutTimes_[day];
}

inline
void
SessionSchedule::logoutTime(
    DayOfWeek::Enum day, TimeOfDay logoutTime)
{
    logoutTimes_[day] = logoutTime;
}

inline
SessionDuration::Enum
SessionSchedule::sessionDuration() const
{
    return sessionDuration_;
}

inline
SequenceNumberResetPolicy::Enum
SessionSchedule::sequenceNumberResetPolicy() const
{
    return seqNumberResetPolicy_;
}

inline
DayOfWeek::Enum
SessionSchedule::sequenceNumberWeeklyResetDay() const
{
    return startOfWeek_;
}
}
}
}