EMA C++ Edition
List of all members
refinitiv::ema::access::OmmInvalidHandleException Class Reference

OmmInvalidHandleException is thrown when application passes in an invalid handle to OmmConsumer. More...

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

Public Member Functions

Accessors
OmmException::ExceptionType getExceptionType () const
  More...
 
const EmaStringgetText () const
  More...
 
const EmaStringtoString () const
  More...
 
UInt64 getHandle () const
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::OmmException
const EmaStringgetExceptionTypeAsString () const
  More...
 
 operator const char * () const
  More...
 

Destructor

UInt64 _handle
 
virtual ~OmmInvalidHandleException ()
  More...
 
 OmmInvalidHandleException (UInt64)
 
 OmmInvalidHandleException (const OmmInvalidHandleException &)
 
OmmInvalidHandleExceptionoperator= (const OmmInvalidHandleException &)
 

Additional Inherited Members

- Public Types inherited from refinitiv::ema::access::OmmException
enum  ExceptionType {
  OmmInvalidUsageExceptionEnum ,
  OmmInvalidConfigurationExceptionEnum ,
  OmmSystemExceptionEnum ,
  OmmOutOfRangeExceptionEnum ,
  OmmInvalidHandleExceptionEnum ,
  OmmMemoryExhaustionExceptionEnum ,
  OmmInaccessibleLogFileExceptionEnum ,
  OmmUnsupportedDomainTypeExceptionEnum ,
  OmmJsonConverterExceptionEnum
}
 
- 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

OmmConsumer uses UInt64 values, called handles to identify individual item streams. OmmConsumer validates each passed in handle against all open and known handles.

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

Definition at line 36 of file OmmInvalidHandleException.h.

Constructor & Destructor Documentation

◆ ~OmmInvalidHandleException()

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

Destructor

Member Function Documentation

◆ getExceptionType()

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

◆ getHandle()

UInt64 refinitiv::ema::access::OmmInvalidHandleException::getHandle ( ) const

Returns the invalid handle.

Returns
UInt64 value of handle causing exception

◆ getText()

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

Returns Text.

Returns
EmaString with exception text information

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

◆ toString()

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

Returns a string representation of the class instance.

Returns
string representation of the class instance

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