OnixS ICE iMpact Multicast Price Feed Handler C++ library  8.11.0
API documentation
LoginResponse.h
Go to the documentation of this file.
1 /**
2  * \file
3  * \brief Declare `OnixS::ICE::iMpact::MarketData::LoginResponse` 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 Login Response Message.
36 struct ONIXS_ICEMDH_EXPORT LoginResponse
37 {
38  /// Message type constant
39  enum { messageType = 'A' };
40 
41  /// The sequence ID in client's request.
43 
44  /// Error code.
46 
47  /// Success or failure messages.
48  std::string text;
49 
50  /// Market type IDs allowed to access for the user.
52 
53  /// Extra field for permissioned market type ids when
54  /// `MarketTypesPermissioned` field is not big enough. This should be
55  /// appended to `MarketTypesPermissioned` if it is not empty.
57 
58  /// Default constructor.
59  LoginResponse();
60 
61  /// Initialize from raw message data.
62  LoginResponse(const char* data, size_t dataSize);
63 
64  /// Deserialize from raw data.
65  void deserialize(const char* data, size_t dataSize);
66 
67  /// Reset all fields to default values.
68  void reset();
69 
70  /// Returns string representation.
71  std::string toString() const;
72 };
73 
74 /// Make it printable using C++ I/O streams.
75 ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const LoginResponse&);
76 
77 }}}} // namespace MarketData, iMpact, ICE, OnixS
std::ostream & operator<<(std::ostream &, const Error &)
Make it printable to formatted C++ I/O streams.
int requestSeqId
The sequence ID in client&#39;s request.
Definition: LoginResponse.h:42
LoginResult::Enum code
Error code.
Definition: LoginResponse.h:45
std::string marketTypesPermissioned
Market type IDs allowed to access for the user.
Definition: LoginResponse.h:51
std::string text
Success or failure messages.
Definition: LoginResponse.h:48
This class represents the Login Response Message.
Definition: LoginResponse.h:36