Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IServerOptions

RPC Server options

Server options, extends the WebSocket server options. Note that WebSocket.IServerOptions.perMessageDeflate defaults to false if omitted.

Hierarchy

  • ServerOptions
    • IServerOptions

Index

Properties

Optional backlog

backlog: undefined | number

Optional clientTracking

clientTracking: undefined | false | true

Optional handleProtocols

handleProtocols: any

Optional host

host: undefined | string

Optional maxPayload

maxPayload: undefined | number

Optional noServer

noServer: undefined | false | true

Optional path

path: undefined | string

Optional perMessageDeflate

perMessageDeflate: boolean | PerMessageDeflateOptions

Optional pingInterval

pingInterval: undefined | number

How often to send a ping frame, in seconds. Set to 0 to disable. Default = 10.

Optional port

port: undefined | number

Optional server

server: Server | Server

Optional verifyClient

verifyClient: VerifyClientCallbackAsync | VerifyClientCallbackSync

Generated using TypeDoc