OnixS C++ Cboe CFE Multicast PITCH Market Data Handler  1.12.0
API documentation
Time.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 
22 #include <vector>
23 
28 
29 
30 namespace OnixS {
31 namespace CboeCFE {
32 namespace MarketData {
33 namespace Pitch {
34 
35  /// Time message is sent whenever the source time for a unit passes over a second boundary
36  struct TimeMsg : public BinaryMessage
37  {
38  /// Number of whole seconds from midnight CentralTime.
39  Binary4 time() const
41  {
42  return ordinary<Binary4>(2);
43  }
44 
45  /// Number of whole seconds since the Epoch (Midnight January 1, 1970 UTC).
48  {
49  return ordinary<Binary4>(6);
50  }
51 
52  /// Total message size.
54 
55  /// Check the given size.
56  static void validateSize(MessageSize size)
57  {
58  if (ONIXS_BATS_PITCH_CHECK_EXPECT((size < messageSize_), false))
59  throwIncorrectSize("Time", size, messageSize_);
60  }
61 
62  /// Initializes instance over given memory block.
63  TimeMsg(const void* data, MessageSize size)
65  : BinaryMessage(data, size)
66  {
67  }
68  };
69 
70  /// Serializes object into string.
71  ONIXS_CBOECFE_PITCH_API void toStr(std::string&, const TimeMsg&);
72 
73  /// Serializes object into string.
74  inline std::string toStr(const TimeMsg& msg)
75  {
76  std::string str;
77  toStr(str, msg);
78  return str;
79  }
80 
81 }
82 }
83 }
84 }
ONIXS_CBOECFE_PITCH_API ONIXS_BATS_PITCH_COLD_PATH ONIXS_BATS_PITCH_NORETURN void throwIncorrectSize(const std::string &messageName, MessageSize receivedSize, MessageSize expectedSize)
static ONIXS_BATS_PITCH_CONST_OR_CONSTEXPR MessageSize messageSize_
Total message size.
Definition: Time.h:53
#define ONIXS_BATS_PITCH_CONST_OR_CONSTEXPR
Definition: Compiler.h:46
Encapsulates services for manipulating little endian encoded messages.
BinaryMessage() ONIXS_BATS_PITCH_NOTHROW
Initializes blank instance referencing to nothing.
Binary2 MessageSize
Aliases message length type.
Definition: Defines.h:90
Binary4 epochTime() const ONIXS_BATS_PITCH_NOTHROW
Number of whole seconds since the Epoch (Midnight January 1, 1970 UTC).
Definition: Time.h:46
#define ONIXS_BATS_PITCH_CHECK_EXPECT(exp, c)
Definition: Compiler.h:52
static void validateSize(MessageSize size)
Check the given size.
Definition: Time.h:56
#define ONIXS_BATS_PITCH_NOTHROW
Definition: Compiler.h:27
ONIXS_CBOECFE_PITCH_API void toStr(std::string &, SideIndicator::Enum)
Appends string presentation of object.
TimeMsg(const void *data, MessageSize size) ONIXS_BATS_PITCH_NOTHROW
Initializes instance over given memory block.
Definition: Time.h:63
Binary4 time() const ONIXS_BATS_PITCH_NOTHROW
Number of whole seconds from midnight CentralTime.
Definition: Time.h:39
Time message is sent whenever the source time for a unit passes over a second boundary.
Definition: Time.h:36