OmmProviderErrorClient class provides callback mechanism used in place of exceptions.
More...
|
virtual | ~OmmProviderErrorClient () |
|
| OmmProviderErrorClient () |
|
By default OmmProvider class throws exceptions if usage errors occur. Specifying OmmProviderErrorClient on the constructor of OmmProvider overwrites this behaviour. Instead of throwing exceptions, respective callback methods on OmmProviderErrorClient will be invoked.
- See also
- OmmProvider, OmmException, OmmInvalidUsageException, OmmInvalidHandleExeption, OmmMemoryExhaustionException, OmmInaccessibleLogFile, OmmSystemException, OmmJsonConverterException, ProviderSessionInfo, EmaString
Definition at line 45 of file OmmProviderErrorClient.h.
◆ onDispatchError()
virtual void refinitiv::ema::access::OmmProviderErrorClient::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::OmmProviderErrorClient::onInaccessibleLogFile |
( |
const EmaString & |
filename, |
|
|
const EmaString & |
text |
|
) |
| |
|
virtual |
Invoked when log file is inaccessible. Requires OmmProvider constructor to have an OmmProviderErrorClient.
- 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::OmmProviderErrorClient::onInvalidHandle |
( |
UInt64 |
handle, |
|
|
const EmaString & |
text |
|
) |
| |
|
virtual |
Invoked upon receiving an invalid handle. Requires OmmProvider constructor to have an OmmProviderErrorClient.
- 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::OmmProviderErrorClient::onInvalidUsage |
( |
const EmaString & |
text | ) |
|
|
virtual |
Invoked in the case of invalid usage. Requires OmmProvider constructor to have an OmmProviderErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
- Returns
- void
◆ onInvalidUsage() [2/2]
virtual void refinitiv::ema::access::OmmProviderErrorClient::onInvalidUsage |
( |
const EmaString & |
text, |
|
|
Int32 |
errorCode |
|
) |
| |
|
virtual |
Invoked in the case of invalid usage. Requires OmmProvider constructor to have an OmmProviderErrorClient.
- 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 OmmProvider constructor to have an OmmProviderErrorClient.
- 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::OmmProviderErrorClient::onMemoryExhaustion |
( |
const EmaString & |
text | ) |
|
|
virtual |
Invoked in the case of memory exhaustion. Requires OmmProvider constructor to have an OmmProviderErrorClient.
- Parameters
-
[out] | text | specifies associated error text |
- Returns
- void
◆ onSystemError()
virtual void refinitiv::ema::access::OmmProviderErrorClient::onSystemError |
( |
Int64 |
code, |
|
|
void * |
ptr, |
|
|
const EmaString & |
text |
|
) |
| |
|
virtual |
Invoked in the case of an underlying system error. Requires OmmProvider constructor to have an OmmProviderErrorClient.
- Parameters
-
[out] | code | specifies system exception code |
[out] | specifies | system exception pointer |
[out] | text | specifies associated error text |
- Returns
- void