vortex.AsyncQueue — PyVortexAsyncQueue class: Vortex library thread safe queue

API documentation for vortex.AsyncQueue object: a thread safe queue used by Vortex Library.

Module API

class vortex.AsyncQueue
push(object)

Allows to push an object into the queue.

Parameters:object (object) – The object to be pushed.
pop()

Allows to retrieve the next object available in the queue

Return type:Returns the object stored in the queue or lock the caller until an object is available.
timedpop(microseconds)

Allows to retrieve the next object available in the queue, limiting the wait period to the provided value (microseconds).

Parameters:microseconds (Number) – How long the wait period must hold
Return type:Returns the object stored in the queue or lock the caller until an object is available or timeout expires, in that case None is returned.