Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CircularBuffer

A circular buffer.

Hierarchy

  • CircularBuffer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new CircularBuffer(length: number, latency: number, littleEndian: boolean): CircularBuffer
  • new CircularBuffer(length: number, latency: number): CircularBuffer
  • Initializes a new instance of the fm.icelink.circularBuffer class.

    Parameters

    • length: number

      The length.

    • latency: number

      The latency.

    • littleEndian: boolean

      Whether the data is little-endian.

    Returns CircularBuffer

  • Initializes a new instance of the fm.icelink.circularBuffer class.

    Parameters

    • length: number

      The length.

    • latency: number

      The latency.

    Returns CircularBuffer

Properties

Private __allowRead

__allowRead: boolean
internal

Private __buffer

__buffer: DataBuffer
internal

Private _latency

_latency: number
internal

Private _littleEndian

_littleEndian: boolean
internal

Private _readOffset

_readOffset: number
internal

Private _writeOffset

_writeOffset: number
internal

Methods

getAvailable

  • getAvailable(): number
  • Gets the number of bytes available for reading.

    Returns number

getLatency

  • getLatency(): number
  • Gets the latency.

    Returns number

getLength

  • getLength(): number
  • Gets the length.

    Returns number

getLittleEndian

  • getLittleEndian(): boolean
  • Gets whether the data is little-endian.

    Returns boolean

getReadOffset

  • getReadOffset(): number
  • Gets the read offset.

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

getWriteOffset

  • getWriteOffset(): number
  • Gets the read offset.

    Returns number

read

  • read(length: number): DataBuffer
  • Reads data from the buffer.

    Parameters

    • length: number

      The number of bytes to read.

    Returns DataBuffer

Private setLatency

  • setLatency(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

Private setLittleEndian

  • setLittleEndian(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

Private setReadOffset

  • setReadOffset(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

Private setWriteOffset

  • setWriteOffset(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

write

  • write(buffer: DataBuffer): void
  • Writes data to the buffer.

    Parameters

    • buffer: DataBuffer

      The data to write.

    Returns void