OnixS BME SENAF Handler C++ library  2.1.0
API documentation
MarketRequestError.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 <OnixS/Senaf/MarketData/Export.h>
23 
24 #include <iosfwd>
25 #include <string>
26 
27 namespace OnixS { namespace Senaf { namespace MarketData {
28 
29 /// Market-Request Error.
30 struct ONIXS_BME_SENAF_EXPORT MarketRequestError
31 {
32  /// Message code.
33  enum { code = 103 };
34 
35  /// Default constructor.
37 
38  /// Market.
39  unsigned char market;
40 
41  /// Error Generator.
42  unsigned char errorGenerator;
43 
44  /// Error Type.
45  unsigned char errorType;
46 
47  /// Text Description.
48  std::string textDescription;
49 
50  /// Request Number that generated the error.
51  unsigned requestNumber;
52 
53  /// Returns string representation.
54  std::string toString() const;
55 
56 private:
57  friend class MessageDeserializer;
58  MarketRequestError(const char* data, size_t dataSize);
59  void deserialize(const char* data, size_t dataSize);
60  void reset();
61 };
62 
63 /// Make it printable using C++ I/O streams.
64 ONIXS_BME_SENAF_EXPORT std::ostream& operator<<(std::ostream&, const MarketRequestError&);
65 
66 }}}
unsigned requestNumber
Request Number that generated the error.
unsigned char errorGenerator
Error Generator.
std::string textDescription
Text Description.
std::ostream & operator<<(std::ostream &, const Error &)
Make it printable to formatted C++ I/O streams.