OnixS ICE iMpact Multicast Price Feed Handler C++ library  8.11.0
API documentation
BundleMarker.h
Go to the documentation of this file.
1 /**
2  * \file
3  * \brief Declare `OnixS::ICE::iMpact::MarketData::BundleMarker` message structure
4  */
5 /*
6  * Copyright (c) Onix Solutions Limited. All rights reserved.
7  *
8  * This software owned by Onix Solutions Limited and is protected by copyright law
9  * and international copyright treaties.
10  *
11  * Access to and use of the software is governed by the terms of the applicable ONIXS Software
12  * Services Agreement (the Agreement) and Customer end user license agreements granting
13  * a non-assignable, non-transferable and non-exclusive license to use the software
14  * for it's own data processing purposes under the terms defined in the Agreement.
15  *
16  * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
17  * of this source code or associated reference material to any other location for further reproduction
18  * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
19  *
20  * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
21  * the terms of the Agreement is a violation of copyright law.
22  */
23 
24 #pragma once
25 
26 #include "../Export.h"
27 #include "../Types.h"
28 #include "../Enumerations.h"
29 
30 #include <iosfwd>
31 #include <string>
32 
33 namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {
34 
35 /// This class represents the Message Bundle Marker.
36 struct ONIXS_ICEMDH_EXPORT BundleMarker
37 {
38  /// Message type constant
39  enum { messageType = 'T' };
40 
41  /// Start/End of a message bundle indicator.
43 
44  /// The value used to associate bundles of the same transaction. This
45  /// value will be `0` when the transaction has no trade. The value will be
46  /// `-1` if the channel does not support sub-bundling.
47  long long tradeTransactionId;
48 
49  /// This field will always be set to `false` for Start of a message
50  /// bundle. true - When this is the last or only bundle for a transaction.
51  /// false - When this is not the last or only bundle for a transaction.
53 
54  /// Default constructor.
55  BundleMarker();
56 
57  /// Initialize from raw message data.
58  BundleMarker(const char* data, size_t dataSize);
59 
60  /// Deserialize from raw data.
61  void deserialize(const char* data, size_t dataSize);
62 
63  /// Reset all fields to default values.
64  void reset();
65 
66  /// Returns string representation.
67  std::string toString() const;
68 };
69 
70 /// Make it printable using C++ I/O streams.
71 ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const BundleMarker&);
72 
73 }}}} // namespace MarketData, iMpact, ICE, OnixS
Enum
Known message bundle markers.
Definition: Enumerations.h:446
std::ostream & operator<<(std::ostream &, const Error &)
Make it printable to formatted C++ I/O streams.
StartOrEnd::Enum startOrEnd
Start/End of a message bundle indicator.
Definition: BundleMarker.h:42
This class represents the Message Bundle Marker.
Definition: BundleMarker.h:36