Saltar al contenido
Meeko
Escribe para buscar en las guías y en la referencia de la API. Ábrela desde cualquier página con / o Ctrl K; muévete con las flechas y entra con Intro.
Empezar

Contenidos

En esta página

NodeSocketUpgradeOptions

interfaz

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

Código fuente 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
}

Ejemplo #

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.

Véase también #

¿Te sirvió esta página?

Añadir un comentario

Se envía al elegir «Sí» o «No». Solo se guardan la página, tu respuesta y el comentario: ni cookies ni datos tuyos.

0 de 2000 caracteres

Editar en GitHub: packages/meeko/src/server/runtime/node-upgrade.ts