@tikoci/centrs
    Preparing search index...

    Interface BtestClientRequest

    interface BtestClientRequest {
        cdbFile?: string;
        cdbPassword?: string;
        connectionCount?: number;
        controlPort?: number;
        direction?: BtestDirection;
        durationMs?: number;
        env?: Record<string, string | undefined>;
        host?: string;
        intervalMs?: number;
        localTxSpeed?: number;
        localUdpTxSize?: number;
        natMode?: boolean;
        onReport?: (record: BtestReportRecord) => void;
        password?: string;
        protocol?: BtestProtocol;
        randomData?: boolean;
        remoteTxSpeed?: number;
        remoteUdpTxSize?: number;
        runSession?: (
            options: BtestClientSessionOptions,
        ) => Promise<BtestRunSummary>;
        signal?: AbortSignal;
        targetInput?: string;
        username?: string;
    }
    Index

    Properties

    cdbFile? cdbPassword? connectionCount? controlPort? direction? durationMs? env? host? intervalMs? localTxSpeed? localUdpTxSize? natMode? onReport? password? protocol? randomData? remoteTxSpeed? remoteUdpTxSize? runSession? signal? targetInput? username?

    Properties

    cdbFile?: string
    cdbPassword?: string
    connectionCount?: number
    controlPort?: number

    Control port; default 2000.

    direction?: BtestDirection
    durationMs?: number
    env?: Record<string, string | undefined>
    host?: string
    intervalMs?: number
    localTxSpeed?: number
    localUdpTxSize?: number
    natMode?: boolean
    onReport?: (record: BtestReportRecord) => void

    Live per-interval frame callback (text/csv streaming).

    password?: string
    protocol?: BtestProtocol
    randomData?: boolean
    remoteTxSpeed?: number
    remoteUdpTxSize?: number
    runSession?: (options: BtestClientSessionOptions) => Promise<BtestRunSummary>

    Injection seam (tests).

    Type Declaration

      • (options: BtestClientSessionOptions): Promise<BtestRunSummary>

      • Run a full btest client session and return its aggregate summary.

        Parameters

        • options: BtestClientSessionOptions

        Returns Promise<BtestRunSummary>

    signal?: AbortSignal
    targetInput?: string

    <router> positional (CDB identity / target / host).

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties