clear_message_queue — Close a message queue handle and release all associated resources.
clear_message_queue( : : QueueHandle : )
clear_message_queue closes a message queue handle QueueHandle that was previously opened with create_message_queue. Any resources owned by the message queue, in particular message data queued in the message queue will be released.
Multiple message queue handles can be closed in a single clear_message_queue call, passing them as a tuple to the QueueHandle parameter.
The handle(s) must not be used again after being invalidated using clear_message_queue. Using an invalid handle results in undefined behavior. Operator clear_message_queue must not be called while the handle is used concurrently from other threads, because this would result in undefined behavior.
Message queue handle(s) to be closed.
Number of elements: QueueHandle >= 1
Restriction: QueueHandle != 0
create_message_queue (ProducerQueue) create_message_queue (ResultQueue) * ... clear_message_queue ([ProducerQueue,ResultQueue])
If the message queue handle(s) passed to the operator are valid, clear_message_queue returns 2 (H_MSG_TRUE). Otherwise an exception is raised. If a tuple of handles is passed and some of them are invalid, clear_message_queue attempts to clear as many handles from the tuple as possible before reporting the error.
create_message_queue, enqueue_message, dequeue_message, set_message_queue_param, get_message_queue_param, create_message, clear_message, set_message_tuple, get_message_tuple, set_message_obj, get_message_obj