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

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

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

Public Member Functions

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

Protected Member Functions

 OmmInvalidHandleException (UInt64)
 
 OmmInvalidHandleException (const OmmInvalidHandleException &)
 
OmmInvalidHandleExceptionoperator= (const OmmInvalidHandleException &)
 
- 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

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

Additional Inherited Members

- Public Types inherited from thomsonreuters::ema::access::OmmException
enum  ExceptionType {
  OmmInvalidUsageExceptionEnum,
  OmmInvalidConfigurationExceptionEnum,
  OmmSystemExceptionEnum,
  OmmOutOfRangeExceptionEnum,
  OmmInvalidHandleExceptionEnum,
  OmmMemoryExhaustionExceptionEnum,
  OmmInaccessibleLogFileExceptionEnum,
  OmmUnsupportedDomainTypeExceptionEnum,
  OmmJsonConverterExceptionEnum
}
 

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

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

Destructor

thomsonreuters::ema::access::OmmInvalidHandleException::OmmInvalidHandleException ( UInt64  )
protected
thomsonreuters::ema::access::OmmInvalidHandleException::OmmInvalidHandleException ( const OmmInvalidHandleException )
protected

Member Function Documentation

OmmException::ExceptionType thomsonreuters::ema::access::OmmInvalidHandleException::getExceptionType ( ) const
virtual
UInt64 thomsonreuters::ema::access::OmmInvalidHandleException::getHandle ( ) const

Returns the invalid handle.

Returns
UInt64 value of handle causing exception
const EmaString& thomsonreuters::ema::access::OmmInvalidHandleException::getText ( ) const
virtual

Returns Text.

Returns
EmaString with exception text information

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

OmmInvalidHandleException& thomsonreuters::ema::access::OmmInvalidHandleException::operator= ( const OmmInvalidHandleException )
protected
const EmaString& thomsonreuters::ema::access::OmmInvalidHandleException::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

UInt64 thomsonreuters::ema::access::OmmInvalidHandleException::_handle
protected

Definition at line 72 of file OmmInvalidHandleException.h.