tibrvQueueGroup_Poll()

Macro

Declaration

tibrv_status tibrvQueueGroup_Poll(
    tibrvQueueGroup    eventQueueGroup);

Purpose

Dispatch an event from a queue group, if possible.

Remarks

If any queue in the group contains an event, then this call searches the queues in priority order, dispatches an event from the first non-empty queue that it finds, and then returns. If all the queues are empty, then this call returns immediately.

When searching the group for a non-empty queue, this call searches according to the priority values of the queues. If two or more queues have identical priorities, subsequent dispatch and poll calls rotate through them in round-robin fashion.

When the call dispatches an event, it returns the status code TIBRV_OK. When the call does not dispatch an event, it returns the status code TIBRV_TIMEOUT.

Parameter

Description

eventQueueGroup

Dispatch the next event from a queue in this group.

See Also

tibrvQueueGroup_Dispatch()

tibrvQueueGroup_TimedDispatch()