Class BlockingQueue<Element>

enqueue blocks when the queue is full, until an item is read with dequeue, or done dequeue blocks when the queue is empty, until an item is added with enqueue, or done done must be called when no more items will be added dequeue returns undefined there are no more items and processing is complete

Type Parameters

  • Element

Hierarchy

Constructors

constructor

Properties

_doneAdding _options _readersWaiting _unreadQueue _writersWaiting

Accessors

length

Methods

areWeDone dequeue done enqueue releaseAllReaders waitForRead waitForWrite

Constructors

constructor

Properties

Private _doneAdding

_doneAdding: boolean = false

Private _options

_options: Required<BlockingQueueOptions>

Private Readonly _readersWaiting

_readersWaiting: Queue<WaiterResolverFunc> = ...

Private Readonly _unreadQueue

_unreadQueue: Queue<Element> = ...

Private Readonly _writersWaiting

_writersWaiting: Queue<WaiterResolverFunc> = ...

Accessors

length

Methods

Private areWeDone

dequeue

  • Gets an element when one is ready, waits if none are ready.

    Returns Promise<undefined | Element>

    Element or undefined if queue is empty and done has been called

done

  • Indicate that no more items will be enqueued.

    This releases all readers blocked on enqueue

    Returns void

enqueue

  • Add an item to the queue, wait if the queue is full.

    Parameters

    • item: Element

      Element to add

    Returns Promise<void>

Private releaseAllReaders

Private waitForRead

  • Waits to be able to add an item to the queue when full

    Returns Promise<void>

Private waitForWrite

  • Waits for an item to be ready in the queue

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc