Interface IRelayServerEvents

Events emitted by RelayServer.

interface IRelayServerEvents {
    broadcast: (from: IRelayConnectedClient, message: IRelayMessage) => void;
    clientJoin: (client: IRelayConnectedClient) => void;
    clientLeave: (client: IRelayConnectedClient) => void;
    close: () => void;
    data: (from: IRelayConnectedClient, message: IRelayMessage) => void;
    error: (err: Error) => void;
    listening: (host: string, port: number) => void;
}

Index

Properties

broadcast clientJoin clientLeave close data error listening

Properties

broadcast

broadcast: (from: IRelayConnectedClient, message: IRelayMessage) => void

A broadcast message was received from a client, before being relayed.

clientJoin

clientJoin: (client: IRelayConnectedClient) => void

A new client has connected and been assigned an ID.

clientLeave

clientLeave: (client: IRelayConnectedClient) => void

A client has disconnected.

close

close: () => void

The server stopped.

data

data: (from: IRelayConnectedClient, message: IRelayMessage) => void

A data message was received from a client, before being relayed.

error

error: (err: Error) => void

The underlying server emitted an error.

listening

listening: (host: string, port: number) => void

The server started listening.