Class Server

RPC Server

Hierarchy

EventEmitter
- Server

Implements

IServerEvents

Index

Constructors

constructor

Properties

Constructors

constructor

new Server(service: Service, options?: IServerOptions): Server

- Defined in server.ts:97
Parameters
- service: Service
  
  The protocol buffer service class to serve.
- Default value options: IServerOptions = {}
  
  Options, see IServerOptions.
Returns Server

Properties

Private connectionCounter

connectionCounter: number = 0

connections

connections: Connection[] = []

List of clients currently connected to server.

handlers

handlers: object

Implemented RPC method handlers, read-only. {@see Service.implement}

Type declaration

[name: string]: Handler

options

options: IServerOptions

Server options, read-only.

Private pingInterval

pingInterval: number

server

server: Server

The underlying uWebSocket server, internal.

service

service: Service

The protobuf Service instance, internal.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in ./node_modules/@types/node/events.d.ts:20
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

broadcast

broadcast(name: string, payload?: Uint8Array): Promise<void>

- Defined in server.ts:145
Send event to all connected clients. {@see Connection.send}

Parameters
- name: string
- Optional payload: Uint8Array
Returns Promise<void>

close

close(): void

- Defined in server.ts:155
Stop listening and close all connections.

Returns void

Private connectionHandler

connectionHandler(socket: WebSocket): void

- Defined in server.ts:162
Parameters
- socket: WebSocket
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in ./node_modules/@types/node/events.d.ts:32
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in ./node_modules/@types/node/events.d.ts:33
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in ./node_modules/@types/node/events.d.ts:29
Returns number

implement

implement(method: Method | string, handler: Handler): void

- Defined in server.ts:128
Implement a RPC method defined in the protobuf service.

Parameters
- method: Method | string
- handler: Handler
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in ./node_modules/@types/node/events.d.ts:34
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in ./node_modules/@types/node/events.d.ts:30
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in ./node_modules/@types/node/events.d.ts:26
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in ./node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in ./node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in ./node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in ./node_modules/@types/node/events.d.ts:24
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in ./node_modules/@types/node/events.d.ts:31
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in ./node_modules/@types/node/events.d.ts:27
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in ./node_modules/@types/node/events.d.ts:25
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in ./node_modules/@types/node/events.d.ts:28
Parameters
- n: number
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in ./node_modules/@types/node/events.d.ts:17
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc