Options
All
  • Public
  • Public/Protected
  • All
Menu

uWebSockets.js v18.1.0 documentation

Index

Type aliases

CompressOptions

CompressOptions: number

WebSocket compression options

RecognizedString

RecognizedString: string | ArrayBuffer | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array

Recognized string types, things C++ can read and understand as strings. "String" does not have to mean "text", it can also be "binary".

Variables

DEDICATED_COMPRESSOR_128KB

DEDICATED_COMPRESSOR_128KB: CompressOptions

Sliding dedicated compress window, requires 128KB of memory per socket

DEDICATED_COMPRESSOR_16KB

DEDICATED_COMPRESSOR_16KB: CompressOptions

Sliding dedicated compress window, requires 16KB of memory per socket

DEDICATED_COMPRESSOR_256KB

DEDICATED_COMPRESSOR_256KB: CompressOptions

Sliding dedicated compress window, requires 256KB of memory per socket

DEDICATED_COMPRESSOR_32KB

DEDICATED_COMPRESSOR_32KB: CompressOptions

Sliding dedicated compress window, requires 32KB of memory per socket

DEDICATED_COMPRESSOR_3KB

DEDICATED_COMPRESSOR_3KB: CompressOptions

Sliding dedicated compress window, requires 3KB of memory per socket

DEDICATED_COMPRESSOR_4KB

DEDICATED_COMPRESSOR_4KB: CompressOptions

Sliding dedicated compress window, requires 4KB of memory per socket

DEDICATED_COMPRESSOR_64KB

DEDICATED_COMPRESSOR_64KB: CompressOptions

Sliding dedicated compress window, requires 64KB of memory per socket

DEDICATED_COMPRESSOR_8KB

DEDICATED_COMPRESSOR_8KB: CompressOptions

Sliding dedicated compress window, requires 8KB of memory per socket

DISABLED

DISABLED: CompressOptions

No compression (always a good idea if you operate using an efficient binary protocol)

SHARED_COMPRESSOR

SHARED_COMPRESSOR: CompressOptions

Zero memory overhead compression (recommended for pub/sub where same message is sent to many receivers)

Functions

App

  • Constructs a non-SSL app. An app is your starting point where you attach behavior to URL routes. This is also where you listen and run your app, set any SSL options (in case of SSLApp) and the like.

    Parameters

    Returns TemplatedApp

SSLApp

us_listen_socket_close

Generated using TypeDoc