Class MultiRingBuffer

Implements

Disposable

Index

Constructors

Properties

buffer encoding head maxSize options readerId readers streams tail

Constructors

constructor

new MultiRingBuffer(options: MultiRingBufferOptions): MultiRingBuffer
Parameters
- options: MultiRingBufferOptions
Returns MultiRingBuffer
- Defined in packages/process/src/node/multi-ring-buffer.ts:104

Properties

`Protected` `Readonly`buffer

buffer: Buffer

`Protected` `Readonly`encoding

encoding: BufferEncoding

`Protected`head

head: number = -1

`Protected` `Readonly`maxSize

maxSize: number

`Protected` `Readonly`options

options: MultiRingBufferOptions

`Protected`readerId

readerId: number = 0

`Protected` `Readonly`readers

readers: Map<number, number>

<id, position>

`Protected` `Readonly`streams

streams: Map<MultiRingBufferReadableStream, number>

`Protected`tail

tail: number = -1

Methods

closeReader

closeReader(id: number): void
Parameters
- id: number
Returns void
- Defined in packages/process/src/node/multi-ring-buffer.ts:159

closeStream

closeStream(readableStream: MultiRingBufferReadableStream): void
Parameters
- readableStream: MultiRingBufferReadableStream
Returns void
- Defined in packages/process/src/node/multi-ring-buffer.ts:170

deq

deq(id: number, size?: number, encoding?: BufferEncoding): undefined | string
Parameters
- id: number
- size: number = -1
- encoding: BufferEncoding = 'utf8'
Returns undefined | string
- Defined in packages/process/src/node/multi-ring-buffer.ts:188

dispose

dispose(): void
Dispose all the attached readers/streams.

Returns void
Implementation of Disposable.dispose
- Defined in packages/process/src/node/multi-ring-buffer.ts:287

empty

empty(): boolean
Returns boolean
- Defined in packages/process/src/node/multi-ring-buffer.ts:268

emptyForReader

emptyForReader(id: number): boolean
Parameters
- id: number
Returns boolean
- Defined in packages/process/src/node/multi-ring-buffer.ts:259

enq

enq(str: string, encoding?: string): void
Parameters
- str: string
- encoding: string = 'utf8'
Returns void
- Defined in packages/process/src/node/multi-ring-buffer.ts:118

getReader

getReader(): number
Returns number
- Defined in packages/process/src/node/multi-ring-buffer.ts:154

getStream

getStream(encoding?: BufferEncoding): MultiRingBufferReadableStream
Parameters
- Optionalencoding: BufferEncoding
Returns MultiRingBufferReadableStream
- Defined in packages/process/src/node/multi-ring-buffer.ts:163

`Protected`inc

inc(pos: number, size: number): WrappedPosition
Parameters
- pos: number
- size: number
Returns WrappedPosition
- Defined in packages/process/src/node/multi-ring-buffer.ts:340

`Protected`incTail

incTail(pos: number, size: number): WrappedPosition
Parameters
- pos: number
- size: number
Returns WrappedPosition
- Defined in packages/process/src/node/multi-ring-buffer.ts:318

`Protected`incTails

incTails(size: number): void
Increment the main tail and all the reader positions.
Parameters
- size: number
Returns void
- Defined in packages/process/src/node/multi-ring-buffer.ts:328

`Protected`incTailSize

incTailSize(pos: number, head: number, size: number): WrappedPosition
Parameters
- pos: number
- head: number
- size: number
Returns WrappedPosition
- Defined in packages/process/src/node/multi-ring-buffer.ts:312

`Protected`isWrapped

isWrapped(from: number, to: number): boolean
Parameters
- from: number
- to: number
Returns boolean
- Defined in packages/process/src/node/multi-ring-buffer.ts:240

`Protected`onData

onData(start: number): void
Parameters
- start: number
Returns void
- Defined in packages/process/src/node/multi-ring-buffer.ts:174

readersSize

readersSize(): number
Returns number
- Defined in packages/process/src/node/multi-ring-buffer.ts:280

`Protected`shouldIncPos

shouldIncPos(pos: number, end: number, size: number): boolean
Position should be incremented if it goes pass end.
Parameters
- pos: number
- end: number
- size: number
Returns boolean
- Defined in packages/process/src/node/multi-ring-buffer.ts:294

size

size(): number
Returns number
- Defined in packages/process/src/node/multi-ring-buffer.ts:236

sizeForReader

sizeForReader(id: number): number
Parameters
- id: number
Returns number
- Defined in packages/process/src/node/multi-ring-buffer.ts:227

`Protected`sizeFrom

sizeFrom(from: number, to: number, wrap: boolean): number
Parameters
- from: number
- to: number
- wrap: boolean
Returns number
- Defined in packages/process/src/node/multi-ring-buffer.ts:247

streamsSize

streamsSize(): number
Returns number
- Defined in packages/process/src/node/multi-ring-buffer.ts:276