EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Types | Friends
thomsonreuters::ema::access::OmmState Class Reference

OmmState represents State information in Omm. More...

Inheritance diagram for thomsonreuters::ema::access::OmmState:
thomsonreuters::ema::access::Data

Public Types

enum  DataState {
  NoChangeEnum = 0,
  OkEnum = 1,
  SuspectEnum = 2
}
 
enum  StatusCode {
  NoneEnum = 0,
  NotFoundEnum = 1,
  TimeoutEnum = 2,
  NotAuthorizedEnum = 3,
  InvalidArgumentEnum = 4,
  UsageErrorEnum = 5,
  PreemptedEnum = 6,
  JustInTimeConflationStartedEnum = 7,
  TickByTickResumedEnum = 8,
  FailoverStartedEnum = 9,
  FailoverCompletedEnum = 10,
  GapDetectedEnum = 11,
  NoResourcesEnum = 12,
  TooManyItemsEnum = 13,
  AlreadyOpenEnum = 14,
  SourceUnknownEnum = 15,
  NotOpenEnum = 16,
  NonUpdatingItemEnum = 19,
  UnsupportedViewTypeEnum = 20,
  InvalidViewEnum = 21,
  FullViewProvidedEnum = 22,
  UnableToRequestAsBatchEnum = 23,
  NoBatchViewSupportInReqEnum = 26,
  ExceededMaxMountsPerUserEnum = 27,
  ErrorEnum = 28,
  DacsDownEnum = 29,
  UserUnknownToPermSysEnum = 30,
  DacsMaxLoginsReachedEnum = 31,
  DacsUserAccessToAppDeniedEnum = 32,
  GapFillEnum = 34,
  AppAuthorizationFailedEnum = 35,
  InvalidFormedMsgEnum = 256,
  ChannelUnavailableEnum = 257,
  ServiceUnavailableEnum = 258,
  ServiceDownEnum = 259,
  ServiceNotAcceptingRequestsEnum = 260,
  LoginClosedEnum = 261,
  DirectoryClosedEnum = 262,
  ItemNotFoundEnum = 263,
  DictionaryUnavailableEnum = 264,
  FieldIdNotFoundDictionaryUnavailableEnum = 265,
  ItemRequestTimeoutEnum = 266
}
 
enum  StreamState {
  OpenEnum = 1,
  NonStreamingEnum = 2,
  ClosedRecoverEnum = 3,
  ClosedEnum = 4,
  ClosedRedirectedEnum = 5
}
 
- Public Types inherited from thomsonreuters::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0,
  BlankEnum = 1
}
 

Public Member Functions

Accessors
const EmaStringgetStreamStateAsString () const
 
const EmaStringgetDataStateAsString () const
 
const EmaStringgetStatusCodeAsString () const
 
DataType::DataTypeEnum getDataType () const
 
Data::DataCode getCode () const
 
const EmaBuffergetAsHex () const
 
const EmaStringtoString () const
 
StreamState getStreamState () const
 
DataState getDataState () const
 
UInt8 getStatusCode () const
 
const EmaStringgetStatusText () const
 
- Public Member Functions inherited from thomsonreuters::ema::access::Data
const EmaStringgetCodeAsString () const
 
 operator const char * () const
 
virtual ~Data ()
 

Friends

class Decoder
 
class RefreshMsgDecoder
 
class StaticDecoder
 
class StatusMsgDecoder
 
class thomsonreuters::ema::domain::login::LoginRefreshImpl
 
class thomsonreuters::ema::domain::login::LoginReqImpl
 
class thomsonreuters::ema::domain::login::LoginStatusImpl
 

Additional Inherited Members

- Protected Member Functions inherited from thomsonreuters::ema::access::Data
 Data ()
 

Detailed Description

OmmState is used to represent state of item, item group and service. OmmState encapsulates stream state, data state, status code and status text information.

Remarks
OmmState is a read only class.
This class is used for extraction of OmmState info only.
All methods in this class are Lock-free Method.
See Also
Data, EmaString, EmaBuffer

Definition at line 50 of file OmmState.h.

Member Enumeration Documentation

An enumeration representing item data state.

Enumerator
NoChangeEnum 

Indicates the health of the data item did not change.

OkEnum 

Indicates the entire data item is healthy.

SuspectEnum 

Indicates the health of some or all of the item's data is stale or unknown.

Definition at line 80 of file OmmState.h.

#enum StatusCode An enumeration representing status code.

Enumerator
NoneEnum 

None

NotFoundEnum 

Not Found

TimeoutEnum 

Timeout

NotAuthorizedEnum 

Not Authorized

InvalidArgumentEnum 

Invalid Argument

UsageErrorEnum 

Usage Error

PreemptedEnum 

Pre-empted

JustInTimeConflationStartedEnum 

Just In Time Filtering Started

TickByTickResumedEnum 

Tick By Tick Resumed

FailoverStartedEnum 

Fail-over Started

FailoverCompletedEnum 

Fail-over Completed

GapDetectedEnum 

Gap Detected

NoResourcesEnum 

No Resources

TooManyItemsEnum 

Too Many Items

AlreadyOpenEnum 

Already Open

SourceUnknownEnum 

Source Unknown

NotOpenEnum 

Not Open

NonUpdatingItemEnum 

Non Updating Item

UnsupportedViewTypeEnum 

Unsupported View Type

InvalidViewEnum 

Invalid View

FullViewProvidedEnum 

Full View Provided

UnableToRequestAsBatchEnum 

Unable To Request As Batch

NoBatchViewSupportInReqEnum 

Request does not support batch or view

ExceededMaxMountsPerUserEnum 

Exceeded maximum number of mounts per user

ErrorEnum 

Internal error from sender

DacsDownEnum 

Connection to DACS down, users are not allowed to connect

UserUnknownToPermSysEnum 

User unknown to permissioning system, it could be DACS, AAA or EED

DacsMaxLoginsReachedEnum 

Maximum logins reached

DacsUserAccessToAppDeniedEnum 

User is not allowed to use application

GapFillEnum 

Content is intended to fill a recognized gap

AppAuthorizationFailedEnum 

Application Authorization Failed

InvalidFormedMsgEnum 

DEPRECATED: Not Used

ChannelUnavailableEnum 

DEPRECATED: Not Used

ServiceUnavailableEnum 

DEPRECATED: Not Used

ServiceDownEnum 

DEPRECATED: Not Used

ServiceNotAcceptingRequestsEnum 

DEPRECATED: Not Used

LoginClosedEnum 

DEPRECATED: Not Used

DirectoryClosedEnum 

DEPRECATED: Not Used

ItemNotFoundEnum 

DEPRECATED: Not Used

DictionaryUnavailableEnum 

DEPRECATED: Not Used

FieldIdNotFoundDictionaryUnavailableEnum 

DEPRECATED: Not Used

ItemRequestTimeoutEnum 

DEPRECATED: Not Used

Definition at line 92 of file OmmState.h.

An enumeration representing item stream state.

Enumerator
OpenEnum 

Indicates the stream is opened and will incur interest after the final refresh.

NonStreamingEnum 

Indicates the item will not incur interest after the final refresh.

ClosedRecoverEnum 

Indicates the stream is closed, typically unobtainable or identity indeterminable due to a comms outage. The item may be available in the future.

ClosedEnum 

Indicates the stream is closed.

ClosedRedirectedEnum 

Indicates the stream is closed and has been renamed. The stream is available with another name. This stream state is only valid for refresh messages. The new item name is in the Name get accessor methods.

Definition at line 57 of file OmmState.h.

Member Function Documentation

const EmaBuffer& thomsonreuters::ema::access::OmmState::getAsHex ( ) const
virtual

Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.

Returns
EmaBuffer with the object hex information

Implements thomsonreuters::ema::access::Data.

Data::DataCode thomsonreuters::ema::access::OmmState::getCode ( ) const
virtual

Returns the Code, which indicates a special state of a DataType.

Returns
Data::BlankEnum if received data is blank; Data::NoCodeEnum otherwise

Implements thomsonreuters::ema::access::Data.

DataState thomsonreuters::ema::access::OmmState::getDataState ( ) const

Returns DataState.

Returns
value of DataState
const EmaString& thomsonreuters::ema::access::OmmState::getDataStateAsString ( ) const

Returns the DataState value as a string format.

Returns
string representation of this object DataState
DataType::DataTypeEnum thomsonreuters::ema::access::OmmState::getDataType ( ) const
virtual

Returns the DataType, which is the type of Omm data. Results in this class type.

Returns
DataType::StateEnum

Implements thomsonreuters::ema::access::Data.

UInt8 thomsonreuters::ema::access::OmmState::getStatusCode ( ) const

Returns StatusCode.

Returns
value of StatusCode
const EmaString& thomsonreuters::ema::access::OmmState::getStatusCodeAsString ( ) const

Returns the StatusCode value as a string format.

Returns
string representation of this object StatusCode
const EmaString& thomsonreuters::ema::access::OmmState::getStatusText ( ) const

Returns StatusText.

Returns
EmaString containing status text information
StreamState thomsonreuters::ema::access::OmmState::getStreamState ( ) const

Returns StreamState.

Returns
value of StreamState
const EmaString& thomsonreuters::ema::access::OmmState::getStreamStateAsString ( ) const

Returns the StreamState value as a string format.

Returns
string representation of this object StreamState
const EmaString& thomsonreuters::ema::access::OmmState::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements thomsonreuters::ema::access::Data.

Friends And Related Function Documentation

friend class Decoder
friend

Definition at line 198 of file OmmState.h.

friend class RefreshMsgDecoder
friend

Definition at line 200 of file OmmState.h.

friend class StaticDecoder
friend

Definition at line 199 of file OmmState.h.

friend class StatusMsgDecoder
friend

Definition at line 201 of file OmmState.h.

friend class thomsonreuters::ema::domain::login::LoginRefreshImpl
friend

Definition at line 203 of file OmmState.h.

friend class thomsonreuters::ema::domain::login::LoginReqImpl
friend

Definition at line 204 of file OmmState.h.

friend class thomsonreuters::ema::domain::login::LoginStatusImpl
friend

Definition at line 202 of file OmmState.h.