Interface ITransport

Common interface implemented by transport/PeerJSTransport.PeerJSTransport and transport/GunTransport.GunTransport.

Remarks

All transports are one-room-per-instance. Call connect() once per session; call disconnect() before switching rooms or transport modes.

interface ITransport {
    status: TransportStatus;
    transportType: TransportType;
    connect(config: TransportConfig): Promise<void>;
    disconnect(): void;
    onEvent(handler: (event: TransportEvent) => void): () => void;
    send(event: TransportEvent): void;
}

Implemented by

Index

Properties

status transportType

Methods

connect disconnect onEvent send

Properties

`Readonly`status

status: TransportStatus

Current connection lifecycle state.

`Readonly`transportType

transportType: TransportType

Which concrete transport is active.

Methods

connect

connect(config: TransportConfig): Promise<void>
Establish a connection to (or create) the specified room.
Parameters
- config: TransportConfig
  Room credentials and mode selection.
Returns Promise<void>
Resolves when the connection is ready to send and receive events.
- Defined in src/transport/types.ts:124

disconnect

disconnect(): void
Tear down the connection and release all resources.

Returns void
- Defined in src/transport/types.ts:127

onEvent

onEvent(handler: (event: TransportEvent) => void): () => void
Subscribe to incoming events.
Parameters
- handler: (event: TransportEvent) => void
  Called for every event received.
Returns () => void
An unsubscribe function — call it to stop receiving events.
- Defined in src/transport/types.ts:140

send

send(event: TransportEvent): void
Send an event to the other side of the connection.
Parameters
- event: TransportEvent
  Any TransportEvent variant.
Returns void
- Defined in src/transport/types.ts:133