Class HttpServerTransport

Interface for server-side transports

Hierarchy (view full)

EventEmitter<HttpServerEvents>
- HttpServerTransport

Implements

IServerTransport

Index

Constructors

Accessors

state isConnected clients actualPort

Methods

on off once emit removeAllListeners listenerCount send close listen onMessage onClientConnect onClientDisconnect sendTo broadcast createHandler

Constructors

constructor

new HttpServerTransport(port, options?): HttpServerTransport
Parameters
- port: number
- options: HttpServerOptions = {}
Returns HttpServerTransport
Overrides EventEmitter.constructor
- Defined in transport/http/server.ts:184

Accessors

state

get state(): TransportState
Current transport state

Returns TransportState
Implementation of IServerTransport.state
- Defined in transport/http/server.ts:202

isConnected

get isConnected(): boolean
Whether the transport is currently connected

Returns boolean
Implementation of IServerTransport.isConnected
- Defined in transport/http/server.ts:206

clients

get clients(): ReadonlyMap<string, IClientConnection>
Currently connected clients

Returns ReadonlyMap<string, IClientConnection>
Implementation of IServerTransport.clients
- Defined in transport/http/server.ts:210

actualPort

get actualPort(): null | number
Get the actual port the server is listening on

Returns null | number
- Defined in transport/http/server.ts:495

Methods

on

on<K>(event, listener): this
Register an event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<HttpServerEvents[K]>
Returns this
Implementation of IServerTransport.on
Inherited from EventEmitter.on
- Defined in transport/event-emitter.ts:17

off

off<K>(event, listener): this
Remove an event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<HttpServerEvents[K]>
Returns this
Implementation of IServerTransport.off
Inherited from EventEmitter.off
- Defined in transport/event-emitter.ts:28

once

once<K>(event, listener): this
Register a one-time event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<HttpServerEvents[K]>
Returns this
Implementation of IServerTransport.once
Inherited from EventEmitter.once
- Defined in transport/event-emitter.ts:37

`Protected` emit

emit<K>(event, ...args): boolean
Emit an event
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- Rest ...args: HttpServerEvents[K]
Returns boolean
Inherited from EventEmitter.emit
- Defined in transport/event-emitter.ts:48

removeAllListeners

removeAllListeners<K>(event?): this
Remove all listeners for an event, or all events
Type Parameters
- K extends keyof TransportEvents
Parameters
- Optional event: K
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in transport/event-emitter.ts:76

listenerCount

listenerCount<K>(event): number
Get the number of listeners for an event
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
Returns number
Inherited from EventEmitter.listenerCount
- Defined in transport/event-emitter.ts:90

send

send(_message): Promise<void>
Send a message through the transport
Parameters
- _message: JsonRpcMessage | JsonRpcResponse
Returns Promise<void>
Promise that resolves when the message is sent (not when response is received)
Implementation of IServerTransport.send
- Defined in transport/http/server.ts:214

close

close(reason?): Promise<void>
Close the transport connection
Parameters
- Optional reason: string
  Optional reason for closing
Returns Promise<void>
Implementation of IServerTransport.close
- Defined in transport/http/server.ts:219

listen

listen(): Promise<void>
Start listening for connections

Returns Promise<void>
Implementation of IServerTransport.listen
- Defined in transport/http/server.ts:248

onMessage

onMessage(handler): void
Register handler for incoming messages from clients
Parameters
- handler: ((message, client) => void)
  - - (message, client): void
    - Parameters
      message: JsonRpcMessage
      client: IClientConnection
      Returns void
Returns void
Implementation of IServerTransport.onMessage
- Defined in transport/http/server.ts:278

onClientConnect

onClientConnect(handler): void
Register handler for client connections
Parameters
- handler: ((client) => void)
  - - (client): void
    - Parameters
      client: IClientConnection
      Returns void
Returns void
Implementation of IServerTransport.onClientConnect
- Defined in transport/http/server.ts:282

onClientDisconnect

onClientDisconnect(handler): void
Register handler for client disconnections
Parameters
- handler: ((client, reason?) => void)
  - - (client, reason?): void
    - Parameters
      client: IClientConnection
      Optional reason: string
      Returns void
Returns void
Implementation of IServerTransport.onClientDisconnect
- Defined in transport/http/server.ts:286

sendTo

sendTo(_clientId, _message): Promise<void>
Send a message to a specific client
Parameters
- _clientId: string
- _message: JsonRpcMessage | JsonRpcResponse
Returns Promise<void>
Implementation of IServerTransport.sendTo
- Defined in transport/http/server.ts:290

broadcast

broadcast(_message): Promise<void>
Broadcast a message to all connected clients
Parameters
- _message: JsonRpcMessage | JsonRpcResponse
Returns Promise<void>
Implementation of IServerTransport.broadcast
- Defined in transport/http/server.ts:294

createHandler

createHandler(): ((req, res) => void)
Create a request handler function for use with existing HTTP servers (Express, Koa, Fastify, etc.)

Returns ((req, res) => void)
- - (req, res): void
  - Parameters
    - req: IncomingMessage
    - res: ServerResponse<IncomingMessage>
    Returns void
- Defined in transport/http/server.ts:306