Skip to content
Meeko
Type to search the guides and the API reference. Open it from any page with / or Ctrl K; move with the arrow keys and open a result with Enter.
Get started

Contents

On this page

Not translated yet

This page has not been translated into English yet, so it is shown in Spanish.

NodeSocketUpgradeOptions

interfaz

ts
import type { NodeSocketUpgradeOptions } from "@meekojs/meeko/node";

Source code src/server/runtime/node-upgrade.ts:49

Declaración #

ts
interface NodeSocketUpgradeOptions {
	hub: SocketHub
	publicOrigin: string
	pathnamePrefix?: string
	maxPendingBytes?: number
	upgrade(incoming: IncomingMessage, socket: Duplex, head: Buffer): Promise<NodeAcceptedSocket> | NodeAcceptedSocket
	reject?(incoming: IncomingMessage, socket: Duplex, status: number): void
	onError?(error: unknown): void
}

Example #

ts
import type { NodeSocketUpgradeOptions } from "@meekojs/meeko/node";

const options: NodeSocketUpgradeOptions = {
  hub: app.socket!.hub,
  publicOrigin: "https://example.com",
  upgrade: (incoming, socket, head) => new Promise((resolve) => wss.handleUpgrade(incoming, socket, head, (ws) => resolve(accepted(ws)))),
};

Miembros #

hub #

propiedad

Hub de la aplicación.

publicOrigin #

propiedad

publicOrigin: string

Origen público fijo; la política de seguridad nunca se deduce de una cabecera Host no confiable.

pathnamePrefix #

propiedad opcional

pathnamePrefix?: string

Prefijo de los canales; por defecto, /_meeko/socket.

maxPendingBytes #

propiedad opcional

maxPendingBytes?: number

Bytes entrantes retenidos mientras el hub autoriza una conexión nueva. Por defecto, 64 KiB.

upgrade #

método

upgrade(incoming: IncomingMessage, socket: Duplex, head: Buffer): Promise<NodeAcceptedSocket> | NodeAcceptedSocket

Hace el upgrade con la librería WebSocket del host.

reject #

método opcional

reject?(incoming: IncomingMessage, socket: Duplex, status: number): void

Responde a un handshake rechazado; por defecto, destruye el socket. Desde 1.1 no recibe los rechazos de sesión (401) ni de autorización del canal (403): esos hacen el upgrade con upgrade y cierran en seguida con 4401 o 4403. Un Origin no permitido sigue llegando aquí con 403.

onError #

método opcional

onError?(error: unknown): void

Observador de los fallos del upgrade y de las sesiones.

See also #

Was this page helpful?

Add a comment

It is sent when you choose “Yes” or “No”. Only the page, your answer and the comment are stored: no cookies and no personal data.

0 of 2000 characters

Edit on GitHub: packages/meeko/src/server/runtime/node-upgrade.ts