OnixS C++ CME iLink 3 Binary Order Entry Handler  1.10.0
API Documentation
SimpleOpenFramingHeader.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 
24 
26 
27 // CME SBE Version 1.0 Little-endian
29 
30 ONIXS_ILINK3_DATA_PACKING_BEGIN(1)
31 
32 /// Simple Open Framing Header.
34 {
35 public:
36  /// Initializes the header.
38  {
39  size(sz);
40  encodingType = CmeSbeEncodingType;
41  }
42 
43  /// Sets the size.
45  {
46  msgSize = val;
47  }
48 
49  /// \return the size
51  {
52  return msgSize;
53  }
54 
55  /// \return the encoding type.
57  {
58  return encodingType;
59  }
60 
61  private:
62  UInt16 msgSize;
63  UInt16 encodingType;
64 
65 };
66 
67 ONIXS_ILINK3_DATA_PACKING_END
68 
69 /// Serializes SimpleOpenFramingHeader into a string.
71 void toStr(std::string&, const SimpleOpenFramingHeader&);
72 
73 inline
74 std::string toStr(const SimpleOpenFramingHeader& header)
75 {
76  std::string res;
77  toStr(res, header);
78  return res;
79 }
80 
#define ONIXS_ILINK3_CONST_OR_CONSTEXPR
Definition: Compiler.h:172
UInt16 UInt16
uInt16.
Definition: Fields.h:264
std::string toStr(const SimpleOpenFramingHeader &header)
#define ONIXS_ILINK3_LTWT_CLASS
Definition: ABI.h:84
#define ONIXS_ILINK3_MESSAGING_NAMESPACE_END
Definition: ABI.h:144
#define ONIXS_ILINK3_EXPORTED
Definition: Compiler.h:168
void setup(UInt16 sz) noexcept
Initializes the header.
#define ONIXS_ILINK3_MESSAGING_NAMESPACE_BEGIN
Definition: ABI.h:140
#define ONIXS_ILINK3_NOTHROW
Definition: Compiler.h:170