Contents

stop

Stops the packet flow between the queue and its target.

Declaration

virtual bool stop();

Return Value

Returns the previous running state of the queue, true if the queue was running, false if the queue was already stopped.

Overview

This method stops the queue and prevents it from sending packets to its target. This call is synchronous and it may block. After this method returns, the queue will no longer call the registered target/action, even as new packets are added to the queue. The queue will continue to absorb new packets until the size of the queue reaches its capacity. The registered action must never call stop(), or a deadlock will occur.

See Also

Miscellaneous