OnixS C++ CME iLink 3 Binary Order Entry Handler 1.18.9
API Documentation
Loading...
Searching...
No Matches
SessionScheduler.h
Go to the documentation of this file.
1/*
2* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
3*
4* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
5* and international copyright treaties.
6*
7* Access to and use of the software is governed by the terms of the applicable OnixS Software
8* Services Agreement (the Agreement) and Customer end user license agreements granting
9* a non-assignable, non-transferable and non-exclusive license to use the software
10* for it's own data processing purposes under the terms defined in the Agreement.
11*
12* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
13* of this source code or associated reference material to any other location for further reproduction
14* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
15*
16* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
17* the terms of the Agreement is a violation of copyright law.
18*/
19
20#pragma once
21
27
28#include <set>
29#include <string>
30
31namespace OnixS {
32namespace CME {
33namespace iLink3 {
34namespace Scheduling {
35
37
38typedef std::string SessionScheduleId;
39typedef std::string SessionConnectionSettingsId;
40
43{
44public:
54 virtual void onLoggingOut(const SessionScheduler & scheduler, Session * session, bool * allowLogout) = 0;
55
57 virtual void onWarning(const SessionScheduler & scheduler, Session * session, const std::string & warningReason) = 0;
58
60 virtual void onError(const SessionScheduler & scheduler, Session * session, const std::string & errorReason) = 0;
61
62protected:
64};
65
90
93{
94public:
95 static const size_t TimeResolutionMs = 10;
96
98
101
107
113
123 SessionScheduler& add(Session *session, const SessionSchedule &schedule, const SessionConnectionSettings &connection);
124
134 SessionScheduler &add(Session *session, const SessionScheduleId &scheduleId, const SessionConnectionSettingsId &connectionId);
135
138
141
144
147
151 int reconnectAttempts() const;
152
155
159 int reconnectInterval() const;
160
163
167 bool utcTimeUsage() const;
168
169private:
170 class Impl;
171 Impl * impl_;
172};
173}
174}
175}
176}
#define ONIXS_ILINK3_EXPORTED
Definition Compiler.h:175
#define ONIXS_ILINK3_DEFAULT
Definition Compiler.h:202
#define ONIXS_ILINK3_NOTHROW
Definition Compiler.h:176
virtual void onWarning(const SessionScheduler &scheduler, Session *session, const std::string &warningReason)=0
Notifies about a non-critical issue.
virtual void onError(const SessionScheduler &scheduler, Session *session, const std::string &errorReason)=0
Notifies about an error.
virtual void onLoggingOut(const SessionScheduler &scheduler, Session *session, bool *allowLogout)=0
Notifies that the session is about to be closed.
const std::string & configurationFile() const noexcept
SessionSchedulerListener * eventListener() const noexcept
SessionScheduler & add(Session *session, const SessionSchedule &schedule, const SessionConnectionSettings &connection)
Adds the session to the automatic connection management.
SessionScheduler & utcTimeUsage(bool value)
Activates the UTC usage.
SessionScheduler & add(Session *session, const SessionScheduleId &scheduleId, const SessionConnectionSettingsId &connectionId)
Adds the session to the automatic connection management.
SessionScheduler & serviceThreadAffinity(const OnixS::CME::iLink3::CpuIndexes &cpuIndexes)
Sets the CPU affinity for the Scheduler service thread.
SessionScheduler(const SessionSchedulerOptions &options)
const SessionConnectionSettings * findConnectionSettings(const SessionConnectionSettingsId &id) const
Looks for the predefined session connection settings associated with the given id that was specified ...
const OnixS::CME::iLink3::CpuIndexes & serviceThreadAffinity() const noexcept
~SessionScheduler()
Performs the graceful shutdown of scheduling sessions.
SessionScheduler & reconnectInterval(int value)
Sets the time interval between the logon attempts in case of a logon failure (in seconds).
SessionScheduler & reconnectAttempts(int value)
Sets the number of logon attempts in case of a logon failure.
const SessionSchedule * findSchedule(const SessionScheduleId &id) const
Looks for the predefined session schedule associated with the given id that was specified in Schedule...
SessionScheduler & remove(Session *session)
Removes the session from the automatic connection management services.
An iLink 3 Session.
Definition Session.h:48
std::set< CpuIndex > CpuIndexes
Definition Defines.h:73