OmmConsumerErrorclient class provides callback mechanism used in place of exceptions.
More...
|
virtual | ~OmmConsumerErrorClient () |
|
| OmmConsumerErrorClient () |
|
By default OmmConsumer class throws exceptions if a usage error occurs. Specifying OmmConsumerErrorClient on the constructor of OmmConsumer overwrites this behaviour. Instead of throwing exceptions, respective callback method on OmmConsumerErrorClient will be invoked.
- See also
- OmmConsumer, OmmException, OmmInvalidUsageException, OmmInvalidHandleExeption, OmmMemoryExhaustionException, OmmInaccessibleLogFile, OmmSystemException, OmmJsonConverterException, ConsumerSessionInfo, EmaString
Definition at line 45 of file OmmConsumerErrorClient.h.
◆ onDispatchError()
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onDispatchError |
( |
const EmaString & |
text, |
|
|
Int32 |
errorCode |
|
) |
| |
|
virtual |
Invoked in the case of dispatching failures from Reactor component. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
[out] | errorCode | specifies associated error code defined in DispatchError |
◆ onInaccessibleLogFile()
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onInaccessibleLogFile |
( |
const EmaString & |
filename, |
|
|
const EmaString & |
text |
|
) |
| |
|
virtual |
Invoked when log file is inaccessible. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | filename | identifies file name that was not able to b open |
[out] | text | specifies associated error text |
- Returns
- void
◆ onInvalidHandle()
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onInvalidHandle |
( |
UInt64 |
handle, |
|
|
const EmaString & |
text |
|
) |
| |
|
virtual |
Invoked upon receiving an invalid handle. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | handle | value of the handle that is invalid |
[out] | text | specifies associated error text |
- Returns
- void
◆ onInvalidUsage() [1/2]
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onInvalidUsage |
( |
const EmaString & |
text | ) |
|
|
virtual |
Invoked in the case of invalid usage. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
- Returns
- void
◆ onInvalidUsage() [2/2]
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onInvalidUsage |
( |
const EmaString & |
text, |
|
|
Int32 |
errorCode |
|
) |
| |
|
virtual |
Invoked in the case of invalid usage. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
[out] | errorCode | specifies associated error code |
- Returns
- void
◆ onJsonConverter()
Invoked in the case of Json converter error. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
[out] | errorCode | specifies associated error code |
[out] | sessionInfo | specifies associated session information |
- Returns
- void
◆ onMemoryExhaustion()
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onMemoryExhaustion |
( |
const EmaString & |
text | ) |
|
|
virtual |
Invoked in the case of memory exhaustion. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
- Returns
- void
◆ onSystemError()
virtual void refinitiv::ema::access::OmmConsumerErrorClient::onSystemError |
( |
Int64 |
code, |
|
|
void * |
ptr, |
|
|
const EmaString & |
text |
|
) |
| |
|
virtual |
Invoked in the case of an underlying system error. Requires OmmConsumer constructor to have an OmmConsumerErrorClient.
- Parameters
-
[out] | code | specifies system exception code |
[out] | specifies | system exception pointer |
[out] | text | specifies associated error text |
- Returns
- void