EMA C++ Edition
OmmState.h
Go to the documentation of this file.
1/*|-----------------------------------------------------------------------------
2 *| This source code is provided under the Apache 2.0 license
3 *| and is provided AS IS with no warranty or guarantee of fit for purpose.
4 *| See the project's LICENSE.md for details.
5 *| Copyright (C) 2019, 2024 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_OmmState_h
10#define __refinitiv_ema_access_OmmState_h
27#include "Access/Include/Data.h"
28
29namespace refinitiv {
30
31namespace ema {
32
33namespace domain {
34
35namespace login {
36
37class LoginReqImpl;
38class LoginRefreshImpl;
39class LoginStatusImpl;
40
41}
42
43}
44
45namespace access {
46
47class OmmStateDecoder;
48
49
51{
52public :
53
58 {
59 OpenEnum = 1,
62 NonStreamingEnum = 2,
65 ClosedRecoverEnum = 3,
69 ClosedEnum = 4,
71 ClosedRedirectedEnum = 5
75 };
76
81 {
82 NoChangeEnum = 0,
84 OkEnum = 1,
86 SuspectEnum = 2
87 };
88
93 {
94 NoneEnum = 0,
95 NotFoundEnum = 1,
96 TimeoutEnum = 2,
97 NotAuthorizedEnum = 3,
98 InvalidArgumentEnum = 4,
99 UsageErrorEnum = 5,
100 PreemptedEnum = 6,
101 JustInTimeConflationStartedEnum = 7,
102 TickByTickResumedEnum = 8,
103 FailoverStartedEnum = 9,
104 FailoverCompletedEnum = 10,
105 GapDetectedEnum = 11,
106 NoResourcesEnum = 12,
107 TooManyItemsEnum = 13,
108 AlreadyOpenEnum = 14,
109 SourceUnknownEnum = 15,
110 NotOpenEnum = 16,
111 NonUpdatingItemEnum = 19,
112 UnsupportedViewTypeEnum = 20,
113 InvalidViewEnum = 21,
114 FullViewProvidedEnum = 22,
115 UnableToRequestAsBatchEnum = 23,
116 NoBatchViewSupportInReqEnum = 26,
117 ExceededMaxMountsPerUserEnum = 27,
118 ErrorEnum = 28,
119 DacsDownEnum = 29,
120 UserUnknownToPermSysEnum = 30,
121 DacsMaxLoginsReachedEnum = 31,
122 DacsUserAccessToAppDeniedEnum = 32,
123 GapFillEnum = 34,
124 AppAuthorizationFailedEnum = 35,
125 InvalidFormedMsgEnum = 256,
126 ChannelUnavailableEnum = 257,
127 ServiceUnavailableEnum = 258,
128 ServiceDownEnum = 259,
129 ServiceNotAcceptingRequestsEnum = 260,
130 LoginClosedEnum = 261,
131 DirectoryClosedEnum = 262,
132 ItemNotFoundEnum = 263,
133 DictionaryUnavailableEnum = 264,
134 FieldIdNotFoundDictionaryUnavailableEnum = 265,
135 ItemRequestTimeoutEnum = 266
136 };
137
139
140
144
149
154
159
164
168 const EmaBuffer& getAsHex() const;
169
173 const EmaString& toString() const;
174
179
184
189
193 const EmaString& getStatusText() const;
195
196private :
197
198 friend class Decoder;
199 friend class StaticDecoder;
200 friend class RefreshMsgDecoder;
201 friend class StatusMsgDecoder;
202 friend class refinitiv::ema::domain::login::LoginStatusImpl;
203 friend class refinitiv::ema::domain::login::LoginRefreshImpl;
204 friend class refinitiv::ema::domain::login::LoginReqImpl;
205
206 Decoder& getDecoder();
207 bool hasDecoder() const;
208
209 const EmaString& toString( UInt64 ) const;
210
211 const Encoder& getEncoder() const;
212 bool hasEncoder() const;
213
214 OmmState();
215 virtual ~~OmmState();
216 OmmState( const OmmState& );
217 OmmState& operator=( const OmmState& );
218
219 OmmStateDecoder* _pDecoder;
220 UInt64 _space[23];
221};
222
223}
224
225}
226
227}
228
229#endif //__refinitiv_ema_access_OmmState_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
unsigned char UInt8
represents 8-bit unsigned integer
Definition: Common.h:32
unsigned long long UInt64
represents 64-bit unsigned integer
Definition: Common.h:68
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
The ema namespace contains all interfaces and definitions specified for use with EMA.
Data class is a parent abstract class defining common interfaces for all Data type classes.
Definition: Data.h:39
EmaBuffer represents a general use binary buffer.
Definition: EmaBuffer.h:33
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:57
OmmState represents State information in Omm.
Definition: OmmState.h:51
const EmaString & getStatusCodeAsString() const
StreamState getStreamState() const
const EmaString & getStreamStateAsString() const
const EmaString & toString() const
const EmaString & getDataStateAsString() const
Data::DataCode getCode() const
DataType::DataTypeEnum getDataType() const
const EmaString & getStatusText() const
const EmaBuffer & getAsHex() const