tibrvQueue_TimedDispatch()

Function

Declaration

tibrv_status tibrvQueue_TimedDispatch(
    tibrvQueue       eventQueue,
    tibrv_f64        timeout);

Purpose

Dispatch an event, but if no event is ready to dispatch, limit the time that this call blocks while waiting for an event.

Remarks

If an event is already in the queue, this call dispatches it, and returns immediately. If the queue is empty, this call waits for an event to arrive. If an event arrives before the waiting time elapses, then it dispatches the event and returns. If the waiting time elapses first, then the call returns without dispatching an event.

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
eventQueue	Dispatch the next event from this queue.
timeout	Maximum time (in seconds) that this call can block while waiting for an event to arrive in the queue. TIBRV_NO_WAIT (zero) indicates no blocking (immediate timeout). TIBRV_WAIT_FOREVER (-1) indicates no timeout.

See Also

tibrvQueue_Dispatch()

tibrvQueue_Poll()