kaven-utils - v6.1.9
    Preparing search index...

    Interface IRelayTunnelPayload

    Payload of a tunnel message (see RelayMessageType.Tunnel).

    Raw tunnel bytes use the relay protocol's binary data-frame representation.

    interface IRelayTunnelPayload {
        connectionId: string;
        data?: Buffer<ArrayBufferLike>;
        error?: string;
        event: RelayTunnelEvent;
        target?: string;
        window?: number;
    }
    Index
    connectionId data? error? event target? window?
    connectionId: string

    Identifier of the proxied connection. Generated by the originator side and echoed back by the peer so both ends can multiplex several connections over a single relay connection.

    data?: Buffer<ArrayBufferLike>

    Raw bytes of the connection. Only present on data messages.

    error?: string

    Optional error description. Present on connectFailed messages.

    event: RelayTunnelEvent

    The phase this tunnel message represents.

    target?: string

    The destination to dial, in host:port form. Only present on connect messages.

    window?: number

    Number of bytes returned to the sender's flow-control window. Only present on windowUpdate messages.

    Settings
    Member Visibility

    On This Page
    Properties