Search Results for

    / fm / liveswitch / DataBufferPoolTracer

    Class: DataBufferPoolTracer

    fm.liveswitch.DataBufferPoolTracer

    A data buffer pool tracer.

    Implements

    • IDataBufferPool

    Table of contents

    Constructors

    • constructor

    Methods

    • getPool
    • getStatistics
    • getTag
    • getTypeString
    • take

    Constructors

    constructor

    + new DataBufferPoolTracer(tag: string, pool: DataBufferPool): DataBufferPoolTracer

    Initializes a new instance of the [[fm.liveswitch.dataBufferPoolTracer]] class.

    Parameters:

    Name Type
    tag string
    pool DataBufferPool

    Returns: DataBufferPoolTracer

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:15

    Methods

    getPool

    ▸ getPool(): DataBufferPool

    Gets the underlying pool.

    Returns: DataBufferPool

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:48


    getStatistics

    ▸ getStatistics(): PoolStatistics

    Gets the traced usage statistics.

    Returns: PoolStatistics

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:60


    getTag

    ▸ getTag(): string

    Gets the tag that identifies requests to the underlying pool.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:72


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:9


    take

    ▸ take(size: number): DataBuffer

    Takes a buffer from the pool.

    Parameters:

    Name Type Description
    size number The number of bytes needed.

    Returns: DataBuffer

    Implementation of: IDataBufferPool

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:101

    ▸ take(size: number, littleEndian: boolean): DataBuffer

    Takes a buffer from the pool.

    Parameters:

    Name Type Description
    size number The number of bytes needed.
    littleEndian boolean Whether the data buffer should be little-endian.

    Returns: DataBuffer

    Implementation of: IDataBufferPool

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:109

    ▸ take(size: number, littleEndian: boolean, clearBytes: boolean): DataBuffer

    Takes a buffer from the pool.

    Parameters:

    Name Type Description
    size number The number of bytes needed.
    littleEndian boolean Whether the data buffer should be little-endian.
    clearBytes boolean Whether to clear the data buffer.

    Returns: DataBuffer

    Implementation of: IDataBufferPool

    Defined in: Generated/TypeScript/fm.liveswitch/DataBufferPoolTracer.ts:118

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0