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

OmmInvalidUsageException is thrown when application violates usage of EMA interfaces. More...

Inheritance diagram for thomsonreuters::ema::access::OmmInvalidUsageException:
thomsonreuters::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,
  PacketGapDetectedEnum = -61,
  SlowReaderEnum = -62,
  CongestionDetectedEnum = -63,
  PersistenceFullEnum = -91,
  InvalidOperationEnum = -4048,
  NoActiveChannelEnum = -4049,
  UnSupportedChannelTypeEnum = - 4050,
  UnSupportedServerTypeEnum = -4051,
  LoginRequestTimeOutEnum = -4052,
  LoginRequestRejectedEnum = -4053,
  DirectoryRequestTimeOutEnum = -4054,
  DictionaryRequestTimeOutEnum = -4055,
  InternalErrorEnum = -4060
}
 
- Public Types inherited from thomsonreuters::ema::access::OmmException
enum  ExceptionType {
  OmmInvalidUsageExceptionEnum,
  OmmInvalidConfigurationExceptionEnum,
  OmmSystemExceptionEnum,
  OmmOutOfRangeExceptionEnum,
  OmmInvalidHandleExceptionEnum,
  OmmMemoryExhaustionExceptionEnum,
  OmmInaccessibleLogFileExceptionEnum,
  OmmUnsupportedDomainTypeExceptionEnum,
  OmmJsonConverterExceptionEnum
}
 

Public Member Functions

Accessors
OmmException::ExceptionType getExceptionType () const
 
const EmaStringgetText () const
 
const EmaStringtoString () const
 
Int32 getErrorCode () const
 
Destructor
virtual ~OmmInvalidUsageException ()
 
- Public Member Functions inherited from thomsonreuters::ema::access::OmmException
const EmaStringgetExceptionTypeAsString () const
 
 operator const char * () const
 

Protected Member Functions

 OmmInvalidUsageException ()
 
 OmmInvalidUsageException (const OmmInvalidUsageException &)
 
OmmInvalidUsageExceptionoperator= (const OmmInvalidUsageException &)
 
- Protected Member Functions inherited from thomsonreuters::ema::access::OmmException
 OmmException ()
 
 OmmException (const OmmException &)
 
OmmExceptionoperator= (const OmmException &)
 
OmmExceptionstatusText (const EmaString &statusText)
 
OmmExceptionstatusText (const char *statusText)
 
const EmaStringtoStringInt () const
 
virtual ~OmmException ()
 

Protected Attributes

Int32 _errorCode
 
- Protected Attributes inherited from thomsonreuters::ema::access::OmmException
char _errorText [MAX_SIZE]
 
UInt32 _errorTextLength
 
char _space [MAX_SIZE_PLUS_PADDING]
 

Detailed Description

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

Definition at line 31 of file OmmInvalidUsageException.h.

Member Enumeration Documentation

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.

PacketGapDetectedEnum 

Multicast Transport Warning: An unrecoverable packet gap was detected and some content may have been lost.

SlowReaderEnum 

Multicast Transport Warning: Application is consuming more slowly than data is being provided. Gaps are likely.

CongestionDetectedEnum 

Multicast Transport Warning: Network congestion detected. Gaps are likely.

PersistenceFullEnum 

Tunnel Stream Failure: This message could not be sent because no space was available to persist it.

InvalidOperationEnum 

Invalid user's operation.

NoActiveChannelEnum 

No active channel.

UnSupportedChannelTypeEnum 

Unsupported channel type.

UnSupportedServerTypeEnum 

Unsupported server type.

LoginRequestTimeOutEnum 

Login request timeout.

LoginRequestRejectedEnum 

Login request rejected from connected peer.

DirectoryRequestTimeOutEnum 

Directory request timeout.

DictionaryRequestTimeOutEnum 

Dictionary request timeout.

InternalErrorEnum 

Internal Error in EMA.

Definition at line 38 of file OmmInvalidUsageException.h.

Constructor & Destructor Documentation

virtual thomsonreuters::ema::access::OmmInvalidUsageException::~OmmInvalidUsageException ( )
virtual

Destructor

thomsonreuters::ema::access::OmmInvalidUsageException::OmmInvalidUsageException ( )
protected
thomsonreuters::ema::access::OmmInvalidUsageException::OmmInvalidUsageException ( const OmmInvalidUsageException )
protected

Member Function Documentation

Int32 thomsonreuters::ema::access::OmmInvalidUsageException::getErrorCode ( ) const

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

Returns
an error code
OmmException::ExceptionType thomsonreuters::ema::access::OmmInvalidUsageException::getExceptionType ( ) const
virtual
const EmaString& thomsonreuters::ema::access::OmmInvalidUsageException::getText ( ) const
virtual

Returns Text.

Returns
EmaString with exception text information

Implements thomsonreuters::ema::access::OmmException.

OmmInvalidUsageException& thomsonreuters::ema::access::OmmInvalidUsageException::operator= ( const OmmInvalidUsageException )
protected
const EmaString& thomsonreuters::ema::access::OmmInvalidUsageException::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements thomsonreuters::ema::access::OmmException.

Member Data Documentation

Int32 thomsonreuters::ema::access::OmmInvalidUsageException::_errorCode
protected

Definition at line 139 of file OmmInvalidUsageException.h.