OnixS C++ CME MDP Conflated TCP Handler  1.2.1
API Documentation
Fields.h
Go to the documentation of this file.
1 // Copyright Onix Solutions Limited [OnixS]. All rights reserved.
2 //
3 // This software owned by Onix Solutions Limited [OnixS] and is
4 // protected by copyright law and international copyright treaties.
5 //
6 // Access to and use of the software is governed by the terms of the applicable
7 // OnixS Software Services Agreement (the Agreement) and Customer end user license
8 // agreements granting a non-assignable, non-transferable and non-exclusive license
9 // to use the software for it's own data processing purposes under the terms defined
10 // in the Agreement.
11 //
12 // Except as otherwise granted within the terms of the Agreement, copying or
13 // reproduction of any part of this source code or associated reference material
14 // to any other location for further reproduction or redistribution, and any
15 // amendments to this copyright notice, are expressly prohibited.
16 //
17 // Any reproduction or redistribution for sale or hiring of the Software not in
18 // accordance with the terms of the Agreement is a violation of copyright law.
19 //
20 
21 #pragma once
22 
26 
28 
29 /// int32.
30 typedef Int32 Int32;
31 
32 
33 /// Unsigned Int16 with NULL.
35 
36 
37 /// uInt32.
38 typedef UInt32 UInt32;
39 
40 
41 /// uInt64.
42 typedef UInt64 UInt64;
43 
44 
45 /// uInt8.
46 typedef UInt8 UInt8;
47 
48 
49 /// `ErrorCodes` type.
51 {
52  typedef UInt8 Base;
53 
54  enum Enum
55  {
56  /// Failed authentication.
57  HMACReject = 0,
58 
59  /// Failed required field validation.
60  InvalidValue = 1,
61 
62  /// Slow connection.
63  SlowConnection = 2,
64 
65  /// Unexpected request, see Reason field for details.
66  Other = 3
67  };
68 
69  /// \return a human-readable presentation.
71  static
72  std::string
73  toString(
74  Enum);
75 };
76 
77 /// `MDReqRejReason` type.
79 {
80  typedef UInt8 Base;
81 
82  enum Enum
83  {
84  /// Unknown Security.
85  UnknownSecurity = 0,
86 
87  /// Unknown or Invalid Message.
88  UnknownMessage = 1,
89 
90  /// Unsupported Scope.
91  UnsupportedScope = 2,
92 
93  /// Other.
94  Other = 3
95  };
96 
97  /// \return a human-readable presentation.
99  static
100  std::string
101  toString(
102  Enum);
103 };
104 
105 /// `RequestIDStatus` type.
107 {
108  typedef UInt8 Base;
109 
110  enum Enum
111  {
112  /// Requested subscription scope is fully acknowledged .
113  FullAck = 0,
114 
115  /// Requested subscription scope is partially acknowledged .
116  PartialAck = 1
117  };
118 
119  /// \return a human-readable presentation.
121  static
122  std::string
123  toString(
124  Enum);
125 };
126 
127 /// `SubscriptionReqType` type.
129 {
130  typedef UInt8 Base;
131 
132  enum Enum
133  {
134  /// Snapshot.
135  Snapshot = 0,
136 
137  /// Snapshot and updates.
138  SnapshotAndUpdates = 1,
139 
140  /// Disable previous subscription.
141  Unsubscribe = 2
142  };
143 
144  /// \return a human-readable presentation.
146  static
147  std::string
148  toString(
149  Enum);
150 };
151 
152 
153 /// Null value for an optional UInt16NULL field.
154 typedef
157 
158 
159 /// Null value for an optional UInt32 field.
160 typedef
163 
164 
165 
#define ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_END
Definition: ABI.h:144
UInt16 UInt16NULL
Unsigned Int16 with NULL.
Definition: Fields.h:34
#define ONIXS_CONFLATEDTCP_NODISCARD
Definition: Compiler.h:198
IntegralConstant< UInt16, 65535 > NullUInt16NULL
Null value for an optional UInt16NULL field.
Definition: Fields.h:156
#define ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_BEGIN
Definition: ABI.h:140
IntegralConstant< UInt32, 4294967295 > NullUInt32
Null value for an optional UInt32 field.
Definition: Fields.h:1776
#define ONIXS_CONFLATEDTCP_LTWT_STRUCT
Definition: ABI.h:88