OnixS C++ ICE Binary Order Entry Handler 1.1.1
API Documentation
Loading...
Searching...
No Matches
BgwSession.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
24
26
29{
30public:
40 BgwSession(const SessionSettings& settings,
42 SessionStorage* storage = nullptr, const std::string& customKey = {}, const Utils::BuildInfo & = Utils::consumerBuildInfo())
43 : Session(SessionType::BGW, settings, listener, storageType, storage, customKey)
44 {}
45
56 BgwSession(SessionReactor& stack, const SessionSettings& settings,
58 SessionStorage* storage = nullptr, const std::string& customKey = {}, const Utils::BuildInfo & = Utils::consumerBuildInfo())
59 : Session(stack, SessionType::BGW, settings, listener, storageType, storage, customKey)
60 {}
61
72 BgwSession(ServiceFactory& service, const SessionSettings& settings,
74 SessionStorage* storage = nullptr, const std::string& customKey = {}, const Utils::BuildInfo & = Utils::consumerBuildInfo())
75 : Session(service, SessionType::BGW, settings, listener, storageType, storage, customKey)
76 {}
77
86 Session& connect(const std::string& host, Port port, const std::string& ipSessionToken);
87
95 Threading::SharedFuture<void> connectAsync(const std::string& host, Port port, const std::string& ipSessionToken);
96
103 Session& connect(const BgwCredentials& bgwCredentials)
104 {
105 return connect(bgwCredentials.host(), bgwCredentials.port(), bgwCredentials.ipSessionToken());
106 }
107
114 {
115 return connectAsync(bgwCredentials.host(), bgwCredentials.port(), bgwCredentials.ipSessionToken());
116 }
117};
118
#define ONIXS_ICEBOE_NAMESPACE_BEGIN
Definition ABI.h:94
#define ONIXS_ICEBOE_NAMESPACE_END
Definition ABI.h:98
#define ONIXS_ICEBOE_EXPORTED
Definition Compiler.h:155
BGW session connection credentials.
Session & connect(const std::string &host, Port port, const std::string &ipSessionToken)
Establishes the connection.
Session & connect(const BgwCredentials &bgwCredentials)
Establishes the connection.
Definition BgwSession.h:103
BgwSession(const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
Constructor.
Definition BgwSession.h:40
BgwSession(SessionReactor &stack, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
Constructor.
Definition BgwSession.h:56
Threading::SharedFuture< void > connectAsync(const std::string &host, Port port, const std::string &ipSessionToken)
Establishes the connection asynchronously.
BgwSession(ServiceFactory &service, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
Constructor.
Definition BgwSession.h:72
Threading::SharedFuture< void > connectAsync(const BgwCredentials &bgwCredentials)
Establishes the connection asynchronously.
Definition BgwSession.h:113
const std::string & ipSessionToken() const noexcept
const std::string & host() const noexcept
Session's network stack reactor interface.
std::string customKey() const
Session & connect(const std::string &host, Port port, const std::string &ipSessionToken={})
Establishes the connection.
Threading::SharedFuture< void > connectAsync(const std::string &host, Port port, const std::string &ipSessionToken={})
Establishes the connection asynchronously.
Session(SessionType::Enum sessionType, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
Constructor.
SessionStorageType::Enum storageType() const noexcept
Represents a future result of an asynchronous operation - a result that will eventually appear in the...
Definition Future.h:175
unsigned short Port
Definition Defines.h:41
@ FileBased
File-based Session Storage.