SocketRoomOptions
interfaz
Opciones de createSocketRoomClass.
import type { SocketRoomOptions } from "@meekojs/meeko/cloudflare";Source code src/cloudflare.ts:527
Declaración #
interface SocketRoomOptions {
readonly maxMessageBytes?: number
readonly autoResponse?: { readonly request: string; readonly response: string } | false
readonly keepHeaders?: readonly string[]
readonly maxPendingPublications?: number
readonly rebuildTimeoutMs?: number
readonly onError?: (error: unknown, requestId: string) => void
}Example #
import type { SocketRoomOptions } from "@meekojs/meeko/cloudflare";
const options: SocketRoomOptions = { keepHeaders: ["accept-language"], maxPendingPublications: 256, autoResponse: false };Propiedades #
maxMessageBytes
#
readonly maxMessageBytes?: numberMensaje entrante más grande; los mayores cierran el peer con 1009. Por defecto, el límite de Socket de la aplicación o 64 KiB.
autoResponse
#
readonly autoResponse?: { readonly request: string; readonly response: string } | falseMensaje de texto que el runtime responde sin despertar el objeto, o false. Por defecto,
ping responde pong. Los pings del protocolo se responden siempre.
keepHeaders
#
readonly keepHeaders?: readonly string[]Cabeceras adicionales de la petición (en minúsculas) que se conservan con cada conexión y que
el canal ve en context.request antes y después de la hibernación. Por defecto sólo se conservan
la cookie de sesión, origin y authorization; "cookie" conserva la cabecera completa. Todo
va en el attachment del WebSocket, limitado a 16.384 bytes: un upgrade que no cabe se rechaza
con 431 antes de aceptar el WebSocket.
maxPendingPublications
#
readonly maxPendingPublications?: numberPublicaciones que una sala acepta antes de entregarlas. Por encima, publish rechaza con
SOCKET_BACKLOG_EXCEEDED (503) y el mensaje no se entrega. Por defecto, 1024.
rebuildTimeoutMs
#
readonly rebuildTimeoutMs?: numberMilisegundos que las publicaciones esperan a una conexión reconstruida tras hibernar, desde el inicio de su reconstrucción; pasado ese plazo, la conexión sólo recibe las publicaciones siguientes. Las conexiones que aún se autorizan tras su upgrade no se esperan. Por defecto, 5000.
onError
#
readonly onError?: (error: unknown, requestId: string) => voidObservador de errores; por defecto, el de la aplicación.