EMA C++ Edition
List of all members | Public Types
refinitiv::ema::access::OmmJsonConverterException Class Referenceabstract

OmmJsonConverterException is thrown when EMA fails to perform for RWF/JSON conversion. More...

Inheritance diagram for refinitiv::ema::access::OmmJsonConverterException:
refinitiv::ema::access::OmmException

Public Types

enum  ErrorCode {
  NoErrorEnum = 0 ,
  FailureEnum = -1 ,
  NoBuffersEnum = -4 ,
  BufferTooSmallEnum = -21 ,
  InvalidArgumentEnum = -22 ,
  EncodingUnavaliableEnum = -23 ,
  UnsupportedDataTypeEnum = -24 ,
  UnexpectedEncoderCallEnum = -25 ,
  IncompleteDataEnum = -26 ,
  SetDefNotProvidedEnum = -27 ,
  InvalidDataEnum = -29 ,
  IllegalLocalSetDefEnum = -30 ,
  TooManyLocalSetDefsEnum = -31 ,
  DuplicateLocalSetDefsEnum = -32 ,
  IteratorOverrunEnum = -33 ,
  ValueOutOfRangeEnum = -34 ,
  DictDuplicateEnumValueEnum = -35
}
 
- Public Types inherited from refinitiv::ema::access::OmmException
enum  ExceptionType {
  OmmInvalidUsageExceptionEnum ,
  OmmInvalidConfigurationExceptionEnum ,
  OmmSystemExceptionEnum ,
  OmmOutOfRangeExceptionEnum ,
  OmmInvalidHandleExceptionEnum ,
  OmmMemoryExhaustionExceptionEnum ,
  OmmInaccessibleLogFileExceptionEnum ,
  OmmUnsupportedDomainTypeExceptionEnum ,
  OmmJsonConverterExceptionEnum
}
 

Public Member Functions

Accessors
OmmException::ExceptionType getExceptionType () const
  More...
 
const EmaStringgetText () const
  More...
 
Int32 getErrorCode () const
  More...
 
const EmaStringtoString () const
  More...
 
virtual const SessionInfogetSessionInfo () const =0
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::OmmException
const EmaStringgetExceptionTypeAsString () const
  More...
 
 operator const char * () const
  More...
 

Destructor

Int32 _errorCode
 
virtual ~OmmJsonConverterException ()
  More...
 
 OmmJsonConverterException ()
 
 OmmJsonConverterException (const OmmJsonConverterException &)
 
OmmJsonConverterExceptionoperator= (const OmmJsonConverterException &)
 

Additional Inherited Members

- Protected Member Functions inherited from refinitiv::ema::access::OmmException
 OmmException ()
 
virtual ~OmmException ()
 
OmmExceptionstatusText (const EmaString &statusText)
 
OmmExceptionstatusText (const char *statusText)
 
const EmaStringtoStringInt () const
 
 OmmException (const OmmException &)
 
OmmExceptionoperator= (const OmmException &)
 
- Protected Attributes inherited from refinitiv::ema::access::OmmException
UInt32 _errorTextLength
 
UInt32 _errorTextPadding
 
char _errorText [MAX_SIZE]
 
char _space [MAX_SIZE_PLUS_PADDING]
 

Detailed Description

Remarks
All methods in this class are Lock-free Method.
See also
OmmException, SessionInfo, OmmConsumerErrorClient, OmmProviderErrorClient

Definition at line 33 of file OmmJsonConverterException.h.

Member Enumeration Documentation

◆ ErrorCode

An enumeration representing error codes for handling the exception.

Enumerator
NoErrorEnum 

No specific error code.

FailureEnum 

General failure.

NoBuffersEnum 

There are no buffers available from the buffer pool.

BufferTooSmallEnum 

The buffer provided does not have sufficient space to perform the operation.

InvalidArgumentEnum 

An invalid argument was provided.

EncodingUnavaliableEnum 

No encoder is available for the data type specified.

UnsupportedDataTypeEnum 

The data type is unsupported, may indicate invalid containerType or primitiveType specified.

UnexpectedEncoderCallEnum 

An encoder was used in an unexpected sequence.

IncompleteDataEnum 

Not enough data was provided.

SetDefNotProvidedEnum 

A Database containing the Set Definition for encoding the desired set was not provided.

InvalidDataEnum 

Invalid data provided to function.

IllegalLocalSetDefEnum 

Set definition is not valid.

TooManyLocalSetDefsEnum 

Maximum number of set definitions has been exceeded.

DuplicateLocalSetDefsEnum 

A duplicate set definition has been received.

IteratorOverrunEnum 

Iterator is nested too deeply. There is a limit of 16 levels.

ValueOutOfRangeEnum 

A value being encoded into a set is outside of the valid range of the type given by that set.

DictDuplicateEnumValueEnum 

A display string had multiple enumerated values that correspond to it.

Definition at line 40 of file OmmJsonConverterException.h.

Constructor & Destructor Documentation

◆ ~OmmJsonConverterException()

virtual refinitiv::ema::access::OmmJsonConverterException::~OmmJsonConverterException ( )
virtual

Destructor

Member Function Documentation

◆ getErrorCode()

Int32 refinitiv::ema::access::OmmJsonConverterException::getErrorCode ( ) const

Returns an error code to describe the error case defined in the ErrorCode enum.

Returns
an error code

◆ getExceptionType()

OmmException::ExceptionType refinitiv::ema::access::OmmJsonConverterException::getExceptionType ( ) const
virtual

◆ getSessionInfo()

virtual const SessionInfo& refinitiv::ema::access::OmmJsonConverterException::getSessionInfo ( ) const
pure virtual

Returns session information.

Returns
SessionInfo with additional session information

◆ getText()

const EmaString& refinitiv::ema::access::OmmJsonConverterException::getText ( ) const
virtual

Returns Text.

Returns
EmaString with exception text information

Implements refinitiv::ema::access::OmmException.

◆ toString()

const EmaString& refinitiv::ema::access::OmmJsonConverterException::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements refinitiv::ema::access::OmmException.