Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MultiRingBufferReadableStream

The MultiRingBuffer is a ring buffer implementation that allows multiple independent readers.

These readers are created using the getReader or getStream functions to create a reader that can be read using deq() or one that is a readable stream.

Hierarchy

  • Readable
    • MultiRingBufferReadableStream

Implements

  • Disposable

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected disposed

disposed: boolean = false

Protected Readonly encoding

encoding: string = 'utf8'

Protected more

more: boolean = false

Protected Readonly reader

reader: number

Protected Readonly ringBuffer

ringBuffer: MultiRingBuffer

Methods

_destroy

  • _destroy(err: null | Error, callback: (err: null | Error) => void): void

  • Parameters

    • err: null | Error
    • callback: (err: null | Error) => void
        • (err: null | Error): void

        • Parameters

          • err: null | Error

          Returns void

    Returns void

_read

  • _read(size: number): void

deq

  • deq(size: number): void

dispose

  • dispose(): void

onData

  • onData(): void