Class RPCServer

The RPCServer class extends RPCBase and implements GroupEmitter to provide a WebSocket-based RPC server with group management and JWT authentication support.

Template: WebSocket

The WebSocket type used by the server.

Hierarchy

  • RPCBase<WebSocket>
    • RPCServer

Implements

Constructors

constructor

Properties

calls clients currentID events functions groupRemoved groups pingTimeout socketData users wss

Methods

addToGroup callRPC close createContext deleteGroup emit emitToGroup groupMemberCount handleUpgrade iterateGroup on onConnection onDisconnect onGroupRemoved onMessage onPing onRPCEvent onRPCMessage onRPCResponse onUserStatus pingClient RegisterAuthorizedFunction RegisterFunction RegisterInternalFunction registerJWTAuth removeFromAllGroups removeFromGroup send sendError sendResponse

Constructors

constructor

  • new RPCServer(port?: number): RPCServer

    Creates an instance of RPCServer.

    Parameters

    • Optionalport: number

      The port number to listen on. If not provided, the server will operate in noServer mode.

    Returns RPCServer

Properties

Protectedcalls

calls: Map<number, (result: any, error: any) => void> = ...

Protectedclients

clients: Set<WebSocket> = ...

ProtectedcurrentID

currentID: number = 0

Protectedevents

events: Map<string, Signal<(context: Context, ...args: any[]) => void>> = ...

Protectedfunctions

functions: Map<string, (context: ServerContext, ...args: any[]) => any> = ...

ProtectedgroupRemoved

groupRemoved: Map<string, () => void> = ...

Protectedgroups

groups: Map<string, Set<WebSocket>> = ...

ProtectedpingTimeout

pingTimeout: number = 30000

ProtectedsocketData

socketData: Map<WebSocket, SocketData> = ...

Protectedusers

users: ServerUsers = ...

Protectedwss

wss: WebSocketServer

The WebSocket server instance.

Methods

addToGroup

  • addToGroup(ws: WebSocket, group: string): void

    Parameters

    • ws: WebSocket
    • group: string

    Returns void

ProtectedcallRPC

  • callRPC<T>(ws: WebSocket, method: string, ...params: unknown[]): Promise<T>

    Type Parameters

    • T

    Parameters

    • ws: WebSocket
    • method: string
    • ...params: unknown[]

    Returns Promise<T>

close

  • close(): void

    Closes the WebSocket server.

    Returns void

ProtectedcreateContext

  • createContext(ws: WebSocket): ServerContext

    Parameters

    • ws: WebSocket

    Returns ServerContext

ProtecteddeleteGroup

  • deleteGroup(group: string): void

    Parameters

    • group: string

    Returns void

emit

  • emit(ws: WebSocket, method: string, ...params: unknown[]): void

    Parameters

    • ws: WebSocket
    • method: string
    • ...params: unknown[]

    Returns void

emitToGroup

  • emitToGroup(group: string, method: string, ...params: unknown[]): void

    Emits an event to all members of a group.

    Parameters

    • group: string

      The name of the group.

    • method: string

      The name of the RPC method.

    • ...params: unknown[]

      The parameters to be passed to the RPC method.

    Returns void

groupMemberCount

  • groupMemberCount(group: string): number

    Returns the number of members in a group.

    Parameters

    • group: string

      The name of the group.

    Returns number

    The number of members in the group.

handleUpgrade

  • handleUpgrade(
        request: IncomingMessage,
        socket: Duplex,
        upgradeHead: Buffer,
    ): void

    Forwards the upgrade request to the WebSocket server. Useful if you have an existing HTTP server and want to handle WebSocket upgrades.

    Parameters

    • request: IncomingMessage
    • socket: Duplex
    • upgradeHead: Buffer

    Returns void

iterateGroup

  • iterateGroup(group: string, cb: (ctx: Context) => void): void

    Iterates over all members of a group and calls a callback function for each member.

    Parameters

    • group: string

      The name of the group.

    • cb: (ctx: Context) => void

      The callback function to be called for each member.

    Returns void

on

  • on(
        name: string,
        method: (context: Context, ...args: unknown[]) => void,
    ): SignalConnection

    Registers an event listener.

    Parameters

    • name: string

      The name of the event.

    • method: (context: Context, ...args: unknown[]) => void

      The function to be called when the event is emitted.

    Returns SignalConnection

    A SignalConnection object.

ProtectedonConnection

  • onConnection(ws: WebSocket): void

    Parameters

    • ws: WebSocket

    Returns void

ProtectedonDisconnect

  • onDisconnect(ws: WebSocket): void

    Parameters

    • ws: WebSocket

    Returns void

onGroupRemoved

  • onGroupRemoved(group: string, method: undefined | () => void): void

    Registers a callback to be called when a group is removed.

    Parameters

    • group: string

      The name of the group.

    • method: undefined | () => void

      The callback function to be called when the group is removed.

    Returns void

ProtectedonMessage

  • onMessage(ws: WebSocket, data: RPCMessage): void

    Parameters

    • ws: WebSocket
    • data: RPCMessage

    Returns void

ProtectedonPing

  • onPing(ws: WebSocket): void

    Parameters

    • ws: WebSocket

    Returns void

ProtectedonRPCEvent

  • onRPCEvent(ws: WebSocket, event: RPCEvent): void

    Parameters

    • ws: WebSocket
    • event: RPCEvent

    Returns void

ProtectedonRPCMessage

  • onRPCMessage(ws: WebSocket, data: RPCCall): void

    Parameters

    • ws: WebSocket
    • data: RPCCall

    Returns void

ProtectedonRPCResponse

  • onRPCResponse(resp: RPCResponse): void

    Parameters

    • resp: RPCResponse

    Returns void

onUserStatus

  • onUserStatus(user: string, listener: (connected: boolean) => void): () => void

    Registers a listener for changes in the user's connection status.

    Parameters

    • user: string

      The username to monitor for connection status changes.

    • listener: (connected: boolean) => void

      A callback function that is invoked when the user's connection status changes. The callback receives a boolean parameter indicating whether the user is connected (true) or disconnected (false).

    Returns () => void

    A function that can be called to remove the listener.

ProtectedpingClient

  • pingClient(ws: WebSocket, data: SocketData): void

    Parameters

    • ws: WebSocket
    • data: SocketData

    Returns void

RegisterAuthorizedFunction

  • RegisterAuthorizedFunction(
        name: string,
        method: (context: Context, ...args: unknown[]) => unknown,
    ): void

    Helper to register an authorized RPC function that requires user authentication.

    Parameters

    • name: string

      The name of the RPC function.

    • method: (context: Context, ...args: unknown[]) => unknown

      The function to be registered.

    Returns void

RegisterFunction

  • RegisterFunction(
        name: string,
        method: (context: Context, ...args: any[]) => any,
    ): void

    Registers an RPC function.

    Parameters

    • name: string

      The name of the RPC function.

    • method: (context: Context, ...args: any[]) => any

      The function to be registered.

    Returns void

ProtectedRegisterInternalFunction

  • RegisterInternalFunction(
        name: string,
        method: (context: ServerContext, ...args: any[]) => any,
    ): void

    Parameters

    • name: string
    • method: (context: ServerContext, ...args: any[]) => any

    Returns void

registerJWTAuth

  • registerJWTAuth(
        authFunction: (token: string) => Promise<undefined | UserInfo>,
    ): void

    Registers a JWT authentication function.

    Parameters

    • authFunction: (token: string) => Promise<undefined | UserInfo>

      A function that takes a JWT token and returns a UserInfo object or undefined.

    Returns void

removeFromAllGroups

  • removeFromAllGroups(ws: WebSocket): void

    Parameters

    • ws: WebSocket

    Returns void

removeFromGroup

  • removeFromGroup(ws: WebSocket, group: string): void

    Parameters

    • ws: WebSocket
    • group: string

    Returns void

Protectedsend

  • send(ws: WebSocket, message: RPCMessage): void

    Parameters

    • ws: WebSocket
    • message: RPCMessage

    Returns void

ProtectedsendError

  • sendError(ws: WebSocket, id: number, error: unknown): void

    Parameters

    • ws: WebSocket
    • id: number
    • error: unknown

    Returns void

ProtectedsendResponse

  • sendResponse(ws: WebSocket, id: number, result: unknown): void

    Parameters

    • ws: WebSocket
    • id: number
    • result: unknown

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods