OnixS C++ SGX Titan ITCH Market Data Handler  1.2.2
API documentation
SystemEventMsg.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 
25 
26 ONIXS_SGXTITAN_ITCH_NAMESPACE_BEGIN
27 
28  /// The system event message type is used to signal a
29  /// market or data feed handler event.
30  struct ONIXS_SGXTITAN_ITCH_API SystemEventMsg : public IncomingMessage
31  {
32  /// Nanoseconds portion of the timestamp
33  UInt32 nanoseconds() const
34  {
35  return ordinary<UInt32>(1);
36  }
37 
38  /// Event Code
41  {
42  return enumeration<EventCode>(5);
43  }
44 
45  /// Total message size.
47 
48  /// Check the given size.
49  static void validateSize(MessageSize size)
50  {
51  if(size < messageSize_)
52  throwIncorrectSize("SystemEventMsg", size, messageSize_);
53  }
54 
55  /// Initializes instance over given memory block.
56  SystemEventMsg(const void* data, MessageSize size)
58  : IncomingMessage(data, size)
59  {
60  }
61  };
62 
63  /// Serializes object into string.
64  ONIXS_SGXTITAN_ITCH_API void toStr(std::string&, const SystemEventMsg&);
65 
66  /// Serializes object into string.
67  inline std::string toStr(const SystemEventMsg& msg)
68  {
69  std::string str;
70  toStr(str, msg);
71  return str;
72  }
73 
74  ///
75  inline std::ostream& operator<<(std::ostream& stream, const SystemEventMsg& msg)
76  {
77  stream << toStr(msg);
78  return stream;
79  }
80 
81 ONIXS_SGXTITAN_ITCH_NAMESPACE_END
#define ONIXS_SGXTITAN_ITCH_CONST_OR_CONSTEXPR
Definition: Compiler.h:46
EventCode::Enum eventCode() const
Event Code.
#define ONIXS_SGXTITAN_ITCH_NOTHROW
Definition: Compiler.h:27
IncomingMessage(const void *data, MessageSize size)
UInt16 MessageSize
Aliases message length type.
Definition: Defines.h:34
static void validateSize(MessageSize size)
Check the given size.
SystemEventMsg(const void *data, MessageSize size)
Initializes instance over given memory block.
UInt32 nanoseconds() const
Nanoseconds portion of the timestamp.
ONIXS_SGXTITAN_ITCH_API void toStr(std::string &, MessageType::Enum)
Appends string presentation of object.
ONIXS_SGXTITAN_ITCH_API std::ostream & operator<<(std::ostream &stream, const ServiceDescriptor &descriptor)
ONIXS_SGXTITAN_ITCH_API void throwIncorrectSize(const std::string &messageName, MessageSize receivedSize, MessageSize expectedSize)