tibrvQueue_Destroy()

Function

Declaration

tibrv_status tibrvQueue_Destroy(
    tibrvQueue    eventQueue);
tibrv_status tibrvQueue_DestroyEx(
    tibrvQueue           eventQueue,
    tibrvQueueOnComplete completionFn,
    void*                closure);

Purpose

Destroy an event queue.

Remarks

When a queue is destroyed, events that remain in the queue are discarded.

When a program destroys a queue, all events associated with the queue become invalid. These invalid events still occupy storage until the program explicitly destroys them, or until the program calls tibrv_Close().

Parameter	Description
eventQueue	Destroy this queue.
completionFn	Rendezvous software runs this function immediately after all event callback functions dispatched from the queue have completed. If no event callback functions are running when the queue is destroyed, the destroy call runs the completion function before returning. If this parameter is NULL, tibrvQueue_DestroyEx() does not run a completion function; instead, its behavior is the same as tibrvQueue_Destroy().
closure	Pass this closure argument to the completion function.

See Also

tibrvQueueOnComplete