Describes miscellaneous APIs supported for Event Stream Processor adapters.
API | Description |
---|---|
int getNumGood(void* adapter); | The Server calls this API to retrieve information from the adapter implementation about the number of good rows processed by the adapter. |
int getNumBad(void* adapter); | The Server calls this API to retrieve information from the adapter implementation about the number of bad rows processed by the adapter. |
int getNumRows(void* adapter); | The Server calls this API to get information from the adapter implementation about the total number of rows processed by the adapter. |
bool canDiscover(void* adapter); | The Server calls this API to retrieve information from the adapter implementation about whether it supports schema discovery functionality. |
bool hasError(void* adapter); | The Server calls this API to get information from the adapter implementation about whether there were any errors during the processing of data. |
void getError(void* adapter, char**errorString); | The Server calls this API to get error information from the adapter implementation. |
void getStatistics(void* adapter, AdapterStatistics* adapterStatistics) | The Server calls this API to retrieve custom
statistics information from an adapter. The Server uses this to
periodically update the _esp_adapter_statistics metadata stream. You
must enable the time-granularity project option to update the
_esp_adapter_statistics metadata stream. The adapter stores its statistics in key value format within the AdapterStatistics object. The AdapterStatistics object is populated using the void addAdapterStatistics(void* adapterStatistics, const char* key, const char* value) API, which is available in the adapter utility library. |
int64_t getLatency(void* adapter) | The Server calls this API to retrieve latency information from the adapter, in microseconds, and uses this information to periodically update the latency column in the _esp_connectors metadata stream. You must enable the time-granularity project option to update the _esp_connectors metadata stream. |