Class MultiRingBuffer

Hierarchy

MultiRingBuffer

Implements

Disposable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MultiRingBuffer(options: MultiRingBufferOptions): MultiRingBuffer

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

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>

Protected Readonly streams

streams: Map<MultiRingBufferReadableStream, number>

Protected tail

tail: number = -1

Methods

closeReader

closeReader(id: number): void

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

closeStream

closeStream(readableStream: MultiRingBufferReadableStream): void

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

deq

deq(id: number, size?: number, encoding?: BufferEncoding): undefined | string

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

dispose

dispose(): void

Implementation of Disposable.dispose
- Defined in packages/process/src/node/multi-ring-buffer.ts:287
Dispose all the attached readers/streams.

Returns void

empty

empty(): boolean

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

emptyForReader

emptyForReader(id: number): boolean

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

enq

enq(str: string, encoding?: string): void

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

getReader

getReader(): number

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

getStream

getStream(encoding?: BufferEncoding): MultiRingBufferReadableStream

- Defined in packages/process/src/node/multi-ring-buffer.ts:163
Parameters
- Optional encoding: BufferEncoding
Returns MultiRingBufferReadableStream

Protected inc

inc(pos: number, size: number): WrappedPosition

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

Protected incTail

incTail(pos: number, size: number): WrappedPosition

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

Protected incTailSize

incTailSize(pos: number, head: number, size: number): WrappedPosition

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

Protected incTails

incTails(size: number): void

- Defined in packages/process/src/node/multi-ring-buffer.ts:328
Parameters
- size: number
Returns void

Protected isWrapped

isWrapped(from: number, to: number): boolean

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

Protected onData

onData(start: number): void

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

readersSize

readersSize(): number

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

Protected shouldIncPos

shouldIncPos(pos: number, end: number, size: number): boolean

- Defined in packages/process/src/node/multi-ring-buffer.ts:294
Parameters
- pos: number
- end: number
- size: number
Returns boolean

size

size(): number

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

sizeForReader

sizeForReader(id: number): number

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

Protected sizeFrom

sizeFrom(from: number, to: number, wrap: boolean): number

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

streamsSize

streamsSize(): number

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