TibrvQueue::destroy()

Method

Declaration

TibrvStatus destroy ();
TibrvStatus destroy (
    TibrvQueueOnComplete* completeCB,
    const void* closure = NULL);

Purpose

Destroy an event queue.

Remarks

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

The destructor calls this method.

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().

A program must not call TibrvQueue::destroy() on the default queue. Closing Tibrv destroys the default queue; see Tibrv::close().

Parameter	Description
completeCB	Rendezvous software runs this method immediately after all event callback methods dispatched from the queue have completed. If no event callback methods are running when the queue is destroyed, the destroy call runs the completion method before returning. If this parameter is NULL, this method does not run a completion.
closure	Pass this closure argument to the completion method.