edgeport - v1.0.3
    Preparing search index...

    Interface StompTransaction

    A STOMP transaction (RFC frames BEGIN/COMMIT/ABORT). Sends made through it are staged by the broker and only delivered to subscribers on StompTransaction.commit; StompTransaction.abort discards them.

    1.0.0

    interface StompTransaction {
        id: string;
        abort(): Promise<void>;
        commit(): Promise<void>;
        send(
            destination: string,
            body: string | Uint8Array<ArrayBufferLike>,
            opts?: { contentType?: string; headers?: Record<string, string> },
        ): Promise<void>;
    }
    Index
    id
    abort commit send
    id: string

    The transaction id carried in the transaction header.

    • Aborts the transaction, discarding all staged sends.

      Returns Promise<void>

    • Commits the transaction, releasing all staged sends.

      Returns Promise<void>

    • Sends a message within the transaction (delivered only after commit).

      Parameters

      • destination: string
      • body: string | Uint8Array<ArrayBufferLike>
      • Optionalopts: { contentType?: string; headers?: Record<string, string> }

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods