Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebSocketServerOptions

表示 WebSocket 服务器的附加选项

Hierarchy

  • object
  • SecureContextOptions & TlsOptions & ServerOptions
    • WebSocketServerOptions

Index

Properties

Properties

Optional ALPNProtocols

ALPNProtocols: string[] | Buffer[] | Uint8Array[] | Buffer | Uint8Array

Optional IncomingMessage

IncomingMessage: IncomingMessage

Optional NPNProtocols

NPNProtocols: string[] | Buffer[] | Uint8Array[] | Buffer | Uint8Array

Optional SNICallback

SNICallback: function

Type declaration

    • (servername: string, cb: function): void

    • Parameters

      • servername: string
      • cb: function
          • (err: Error | null, ctx: SecureContext): void

          • Parameters

            • err: Error | null
            • ctx: SecureContext

            Returns void

      Returns void

Optional ServerResponse

ServerResponse: ServerResponse

Optional backlog

backlog: number

允许的最大连接数

Optional ca

ca: string | Buffer | Array<string | Buffer>

Optional cert

cert: string | Buffer | Array<string | Buffer>

Optional ciphers

ciphers: string

Optional clientCertEngine

clientCertEngine: string

Optional crl

crl: string | Buffer | Array<string | Buffer>

Optional dhparam

dhparam: string | Buffer

Optional ecdhCurve

ecdhCurve: string

Optional handshakeTimeout

handshakeTimeout: number

Optional honorCipherOrder

honorCipherOrder: boolean

Optional key

key: string | Buffer | Array<Buffer | Object>

Optional maxVersion

maxVersion: SecureVersion

Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

Optional minVersion

minVersion: SecureVersion

Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

Optional passphrase

passphrase: string

Optional path

path: string

服务器的路径

default

""

Optional pfx

pfx: string | Buffer | Array<string | Buffer | Object>

Optional rejectUnauthorized

rejectUnauthorized: boolean

Optional requestCert

requestCert: boolean

Optional secureOptions

secureOptions: number

Optional secureProtocol

secureProtocol: string

Optional selectProtocol

selectProtocol: function

选择合适的子协议

param

所有可用的子协议

Type declaration

    • (protocols: string[]): string

    • Parameters

      • protocols: string[]

      Returns string

Optional sessionIdContext

sessionIdContext: string

Optional sessionTimeout

sessionTimeout: number

Optional ticketKeys

ticketKeys: Buffer

Optional verify

verify: function

验证是否允许指定的客户端连接

param

当前的请求对象

param

当前的 TCP/IP 套接字对象

param

当前的 WebSocket 服务器

Type declaration

    • (request: IncomingMessage, socket: Socket, server: WebSocketServer): boolean | Promise<boolean>

    • Parameters

      Returns boolean | Promise<boolean>

Generated using TypeDoc