Class RpcServer

Index

Constructors

Accessors

Methods

addTransport listen close expose unexpose use notify broadcast getMethods getMethodInfo getClientIds

Constructors

constructor

new RpcServer(options?): RpcServer
Parameters
- options: RpcServerOptions = {}
Returns RpcServer
- Defined in server/rpc-server.ts:114

Accessors

clientCount

get clientCount(): number
Get connected client count

Returns number
- Defined in server/rpc-server.ts:226

Methods

addTransport

addTransport(transport): this
Add a transport to the server
Parameters
- transport: IServerTransport
Returns this
- Defined in server/rpc-server.ts:129

listen

listen(): Promise<void>
Start listening on all transports

Returns Promise<void>
- Defined in server/rpc-server.ts:138

close

close(): Promise<void>
Stop all transports

Returns Promise<void>
- Defined in server/rpc-server.ts:145

expose

expose<TParams, TResult>(method, handler, options?): this
Register an RPC method
Type Parameters
- TParams extends JsonRpcParams = JsonRpcParams
- TResult = unknown
Parameters
- method: string
- handler: MethodHandler<TParams, TResult>
- options: MethodOptions = {}
Returns this
- Defined in server/rpc-server.ts:153

unexpose

unexpose(method): boolean
Unregister an RPC method
Parameters
- method: string
Returns boolean
- Defined in server/rpc-server.ts:169

use

use(middleware): this
Add middleware to the processing chain
Parameters
- middleware: Middleware
Returns this
- Defined in server/rpc-server.ts:176

notify

notify(clientId, method, params?): Promise<void>
Send a notification to a specific client
Parameters
- clientId: string
- method: string
- Optional params: JsonRpcParams
Returns Promise<void>
- Defined in server/rpc-server.ts:184

broadcast

broadcast(method, params?): Promise<void>
Broadcast a notification to all connected clients
Parameters
- method: string
- Optional params: JsonRpcParams
Returns Promise<void>
- Defined in server/rpc-server.ts:201

getMethods

getMethods(): string[]
Get list of registered methods

Returns string[]
- Defined in server/rpc-server.ts:212

getMethodInfo

getMethodInfo(method): undefined | MethodOptions
Get method metadata
Parameters
- method: string
Returns undefined | MethodOptions
- Defined in server/rpc-server.ts:219

getClientIds

getClientIds(): string[]
Get all connected client IDs

Returns string[]
- Defined in server/rpc-server.ts:233