OnixS C++ eSpeed ITCH Market Data Handler  1.6.0
API documentation
LogSettings.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 
25 #include <string>
26 
28 
29 /// Log level.
30 struct ONIXS_ESPEED_ITCH_API LogLevel
31 {
32  enum Enum
33  {
34  Fatal, ///< Fatal error, cannot continue.
35  Error, ///< System error, but we can go on.
36  Warning, ///< User or logic error, just say about it.
37  Info, ///< Information message.
38  Trace, ///< Used for tracing, usually including functions' names and args.
39  Debug, ///< Used for debugging.
40  };
41 };
42 
43 /// Returns string representation of ErrorCode value.
44 ONIXS_ESPEED_ITCH_API std::string enumToString (LogLevel::Enum);
45 
46 /// Logging options.
47 struct ONIXS_ESPEED_ITCH_API LogSettings
48 {
49  enum Enum
50  {
51  /// Disable all tracing.
52  ///
53  NoTrace = 0x00,
54 
55  /// Trace to the log file.
56  TraceToFile = 0x01,
57 
58  /// Duplicate log messages to console.
59  /// @note Messages with LogLevel::Trace and LogLevel::Debug are not duplicated to console.
60  TraceToConsole = 0x02,
61 
62  /// Enable asynchronous logging.
63  ///
64  /// @note Instead of direct output to file or console, handler put log message into
65  /// interthread queue, that will be processed by auxilary thread.
66  Async = 0x04,
67 
68  /// if TraceToConsole is set, then direct output to stderr
69  ConsoleErr = 0x8,
70 
71  /// if TraceToConsole is set, then set up colored output mode
72  ConsoleColored = 0x10,
73 
74  /// if TraceToConsole is set, then append prefix to output
75  ConsoleShowPrefix = 0x20,
76 
77  /// Log binary data of received packets, applied only for Info log level and below.
78  LogPackets = 0x40,
79 
80  /// Log updated order book, applied only for Debug log level.
81  LogBooks = 0x80,
82 
83  /// Default log settings.
84  Default = TraceToFile | LogPackets | LogBooks
85  };
86 };
87 
88 /// Typed logical operator helper.
90 {
91  return LogSettings::Enum ( static_cast<int>(a) | static_cast<int>(b) );
92 }
93 
94 
95 /// Log file read permissions.
96 struct ONIXS_ESPEED_ITCH_API LogFilePermission
97 {
98  enum Enum
99  {
100  /// read access only for owner of process
101  ReadOwnerOnly = 0x01,
102 
103  /// read access for all
104  ReadAll = 0x02,
105 
106  /// write access only for owner of process
107  WriteOwnerOnly = 0x04,
108 
109  /// write access for all
110  WriteAll = 0x08,
111 
112  /// Default value
113  Default = ReadAll | WriteOwnerOnly
114  };
115 };
116 
117 /// Typed logical operator helper.
119 {
120  return static_cast<LogFilePermission::Enum> (static_cast<int> (a) | static_cast<int> (b) );
121 }
122 
#define ONIXS_ESPEED_ITCH_NAMESPACE_END
Definition: Bootstrap.h:31
#define ONIXS_ESPEED_ITCH_NAMESPACE_BEGIN
Definition: Bootstrap.h:27
Used for tracing, usually including functions&#39; names and args.
Definition: LogSettings.h:38
ONIXS_ESPEED_ITCH_API std::string enumToString(LogLevel::Enum)
Returns string representation of ErrorCode value.
Log level.
Definition: LogSettings.h:30
Fatal error, cannot continue.
Definition: LogSettings.h:34
Used for debugging.
Definition: LogSettings.h:39
Information message.
Definition: LogSettings.h:37
Log file read permissions.
Definition: LogSettings.h:96
LogSettings::Enum operator|(LogSettings::Enum a, LogSettings::Enum b)
Typed logical operator helper.
Definition: LogSettings.h:89
User or logic error, just say about it.
Definition: LogSettings.h:36
Logging options.
Definition: LogSettings.h:47
System error, but we can go on.
Definition: LogSettings.h:35