Documentation
    Preparing search index...

    Interface TransportOptionsBase

    Options shared by node and relay constructions.

    interface TransportOptionsBase {
        agentsReceivedCallback: AgentsReceivedCallback;
        id?: string;
        networkAccessBytes?: NetworkAccessBytes;
        networkAccessHandler: NetworkAccessHandler;
        peerConnectedCallback: PeerConnectedCallback;
        peerDisconnectedCallback?: PeerDisconnectedCallback;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agentsReceivedCallback id? networkAccessBytes? networkAccessHandler peerConnectedCallback peerDisconnectedCallback?

    Properties

    agentsReceivedCallback: AgentsReceivedCallback

    Called when agent-info bytes have been received from a peer.

    id?: string

    Optional human-readable identifier attached to log records.

    networkAccessBytes?: NetworkAccessBytes

    Network access bytes sent in handshake responses (and outbound handshakes for nodes).

    Defaults to new Uint8Array([0]) — an empty array breaks the counter-handshake because .send() would be a no-op.

    networkAccessHandler: NetworkAccessHandler

    Handler invoked for every incoming access handshake. Returns true to grant access, false to deny. Denials are sticky for the session.

    peerConnectedCallback: PeerConnectedCallback

    Called when an inbound peer completes the access handshake. Fire-and-forget.

    peerDisconnectedCallback?: PeerDisconnectedCallback

    Called when a peer disconnects. Fire-and-forget.

    Settings

    Member Visibility

    On This Page

    Properties