eth32_get_event_queue_status

int eth32_get_event_queue_status(eth32 handle, int *maxsize, int *fullqueue, int *cursize);

Summary

This function retrieves the current configuration and status information about the event queue within the API. It allows you to find out the maximum queue size that is currently configured, the queue behavior when the queue becomes full, and the current number of events currently waiting in the queue. Since the queue and its configuration are within the API, this function does not retrieve any information from the ETH32 device. Please see the eth32_set_event_queue_config function for more information about the event queue configuration.

Parameters

  • handle - The value returned by the eth32_open function.

  • maxsize - Pointer to a variable which will receive the currently configured maximum size (maximum number of events) that can be held in the queue.

  • fullqueue - Pointer to a variable which will receive a value indicating the queue behavior after the queue becomes full. This can be QUEUE_DISCARD_NEW or QUEUE_DISCARD_OLD.

  • cursize - Pointer to a variable which will receive the current number of events that are in the queue.

Return Value

This function returns zero on success and a negative error code on failure. Please see the Error Codes section for possible error codes.

See Also

eth32_dequeue_event, eth32_enable_event, eth32_set_event_queue_config