OnixS CME Drop Copy Handler C++ library  5.7.0
API documentation
Initialization.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
13  * part of this source code or associated reference material to any other location for further
14  * reproduction or redistribution, and any amendments to this copyright notice, are expressly
15  * prohibited.
16  *
17  * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
18  * the terms of the Agreement is a violation of copyright law.
19  */
20 
21 #pragma once
22 
23 #include "OnixS/CME/DropCopy/Export.h"
24 
25 #include <string>
26 
27 namespace OnixS { namespace CME { namespace DropCopy {
28 
29 /// Collection of attributes for one-time initialization.
30 struct ONIXS_CME_DROP_COPY_EXPORT InitializationSettings
31 {
32  /// Path to the FIX Engine configuration file.
33  ///
34  /// \note The default value is empty string.
35  std::string fixEngineConfigFile;
36 
37  /// Path to the CME FIX dictionary file.
38  ///
39  /// \note The default value is "CmeDropCopyFixDialect.xml".
40  std::string fixDictionaryFile;
41 
42  /// Path the FIX Engine log directory.
43  ///
44  /// \note The default value is empty string.
45  std::string fixEngineLogDirectory;
46 
47  /// Content of the license file as a string.
48  ///
49  /// \note Default value is empty string.
50  /// \note The Handler checks this license first.
51  std::string licenseString;
52 
53  /// Path to the folder in which licenses are stored.
54  ///
55  /// \note The default value is "./".
56  std::string licenseStore;
57 
58  ///
59  /// Initializes settings with default values.
60  ///
62 
63  ///
64  /// Returns the text representation.
65  ///
66  std::string toString() const;
67 };
68 
69 /// One-time initialization of market data services.
70 ONIXS_CME_DROP_COPY_EXPORT void initialize(const InitializationSettings&);
71 
72 /// Cleans up everything done by one-time initialization.
73 ///
74 /// Has no effect while there's at least one instance
75 /// of the Handler is constructed. Thus, is to be invoked
76 /// when no Handler instances are allocated.
77 ONIXS_CME_DROP_COPY_EXPORT void finalize();
78 
79 }}} // namespace OnixS::CME::DropCopy
Collection of attributes for one-time initialization.
void initialize(const InitializationSettings &)
One-time initialization of market data services.