SocketHubOptions
interfaz
Opciones de createSocketHub.
import type { SocketHubOptions } from "@meekojs/meeko/server";Código fuente src/server/socket/runtime.ts:216
Declaración #
interface SocketHubOptions<TServices = unknown> {
channels: Readonly<Record<string, unknown>>
sessions: SessionManager
services: TServices | ((request: Request) => TServices | Promise<TServices>)
allowedOrigins?: readonly string[]
maxMessageBytes?: number
maxBufferBytes?: number
maxPendingDeliveries?: number
sessionRefreshMs?: number
pubsub?: SocketPubSub
platform?: ServerPlatform
onDeliveryError?(error: unknown, context: SocketDeliveryErrorContext): void
}Parámetros de tipo #
-
TServices= unknown Tipo de los servicios.
Ejemplo #
import type { SocketHubOptions } from "@meekojs/meeko/server";
const options: SocketHubOptions = {
channels,
sessions,
services: {},
maxMessageBytes: 16 * 1024,
onDeliveryError: (error, { channel, room, event }) => console.warn(channel, room, event, error),
};Miembros #
channels
#
channels: Readonly<Record<string, unknown>>Definiciones de los canales por nombre, como las de loadSocketChannels.
services
#
services: TServices | ((request: Request) => TServices | Promise<TServices>)Servicios compartidos o una función que los crea en cada handshake.
maxMessageBytes
#
maxMessageBytes?: numberMensaje entrante o saliente más grande, serializado; broadcast rechaza los mayores. Por defecto, 64 KiB.
maxBufferBytes
#
maxBufferBytes?: numberBytes salientes pendientes por peer antes de cerrarlo; 1 MiB por defecto.
maxPendingDeliveries
#
maxPendingDeliveries?: numberEntregas del broker en espera para un peer local, contando la que está en curso. Un peer más
retrasado se cierra con 1013 y se informa con SOCKET_BACKLOG_EXCEEDED. Por defecto, 256.
sessionRefreshMs
#
sessionRefreshMs?: numberMilisegundos durante los que las entregas reutilizan la última lectura de sesión del peer en
lugar de releer el store. Una revocación cierra el peer al momento mediante
SessionHandle.signal; 0 relee en cada entrega. La autorización se ejecuta en cada entrega.
Por defecto, 1000.
platform
#
platform?: ServerPlatformRuntime que se expone en RequestContext.platform en los callbacks del canal.
onDeliveryError
#
onDeliveryError?(error: unknown, context: SocketDeliveryErrorContext): voidRecibe las entregas fallidas a un peer local, que se cierra, y las desuscripciones asíncronas
fallidas (sin event). Nunca llega al emisor. Por defecto, console.error.