RTCForge API Reference v1.1.1
    Preparing search index...

    Variable TransferStateConst

    TransferState: {
        Accepted: "accepted";
        Active: "active";
        Cancelled: "cancelled";
        Completed: "completed";
        Completing: "completing";
        Failed: "failed";
        Idle: "idle";
        Offered: "offered";
        Paused: "paused";
    } = ...

    Lifecycle states of a Transfer. A transfer advances monotonically toward one of the three terminal states (TransferState.Completed, TransferState.Failed, TransferState.Cancelled).

    Type Declaration

    • ReadonlyAccepted: "accepted"

      The offer was accepted; the transfer is preparing to move bytes.

    • ReadonlyActive: "active"

      Chunks are actively flowing across the data channel(s).

    • ReadonlyCancelled: "cancelled"

      Terminal: the transfer was cancelled by either peer.

    • ReadonlyCompleted: "completed"

      Terminal: the file was transferred (and verified when checksums are enabled).

    • ReadonlyCompleting: "completing"

      All bytes have been exchanged; finalizing (checksum verification, sink close).

    • ReadonlyFailed: "failed"

      Terminal: the transfer aborted because of an error.

    • ReadonlyIdle: "idle"

      Newly constructed; nothing has been sent or offered yet.

    • ReadonlyOffered: "offered"

      An offer has been sent (sender) or received (receiver) and is awaiting acceptance.

    • ReadonlyPaused: "paused"

      Transfer is temporarily suspended and will resume where it left off.