Ether Framework
Unified API docs for Ether modules
Loading...
Searching...
No Matches
Package dev.rafex.ether.websocket.core

Classes

interface  WebSocketEndpoint
 Define el contrato de un punto final WebSocket. More...
class  WebSocketPatterns
 Utilidad para el matching de patrones de rutas WebSocket. More...
class  WebSocketRouteMatcher
 Utilidad que resuelve la primera WebSocketRoute que coincide con un path dado. More...
interface  WebSocketSession
 Representa una sesión WebSocket activa. More...

Functions

record WebSocketCloseStatus (int code, String reason)
 Representa un estado de cierre de una conexión WebSocket conforme a la especificación RFC 6455.
record WebSocketRoute (String pattern, WebSocketEndpoint endpoint)
 Vincula un patrón de ruta WebSocket con el WebSocketEndpoint que la maneja.
record WebSocketRouteMatch (WebSocketRoute route, Map< String, String > pathParams)
 Representa el resultado de una coincidencia exitosa entre un path entrante y una WebSocketRoute.

Function Documentation

◆ WebSocketCloseStatus()

record dev.rafex.ether.websocket.core.WebSocketCloseStatus ( int code,
String reason )

Representa un estado de cierre de una conexión WebSocket conforme a la especificación RFC 6455.

Cada estado se compone de un código numérico y una razón descriptiva.

Cierre normal: la conexión se completó con éxito.

El punto de partida se aleja (el servidor se apaga o el cliente navega fuera).

La conexión se cierra debido a una violación del protocolo.

Se recibió un tipo de mensaje que no es aceptable.

El servidor encontró un error inesperado que impide continuar.

Crea un estado de cierre con el código y la razón especificados.

Parameters
codecódigo de cierre numérico según RFC 6455
reasondescripción legible del motivo de cierre; se normaliza a cadena vacía si es null
Returns
nueva instancia de WebSocketCloseStatus

Definition at line 33 of file WebSocketCloseStatus.java.

References WebSocketCloseStatus().

Referenced by dev.rafex.ether.websocket.core.WebSocketSession.close(), dev.rafex.ether.websocket.core.WebSocketEndpoint.onClose(), and WebSocketCloseStatus().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WebSocketRoute()

record dev.rafex.ether.websocket.core.WebSocketRoute ( String pattern,
WebSocketEndpoint endpoint )

Vincula un patrón de ruta WebSocket con el WebSocketEndpoint que la maneja.

El patrón define qué URLs entrantes activan el endpoint asociado.

Crea una ruta WebSocket que asocia el patrón dado con el endpoint indicado.

Parameters
patternpatrón de ruta a comparar contra paths entrantes (por ejemplo, "/chat")
endpointendpoint que procesa las conexiones que coinciden con el patrón
Returns
nueva instancia de WebSocketRoute
Exceptions
NullPointerExceptionsi pattern o endpoint son null

Definition at line 35 of file WebSocketRoute.java.

References WebSocketRoute().

Referenced by WebSocketRoute(), and WebSocketRouteMatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WebSocketRouteMatch()

record dev.rafex.ether.websocket.core.WebSocketRouteMatch ( WebSocketRoute route,
Map< String, String > pathParams )

Representa el resultado de una coincidencia exitosa entre un path entrante y una WebSocketRoute.

Contiene la ruta que coincidió y los parámetros de path extraídos durante el matching.

Definition at line 35 of file WebSocketRouteMatch.java.

References WebSocketRoute().

Referenced by dev.rafex.ether.websocket.core.WebSocketRouteMatcher.match().

Here is the call graph for this function:
Here is the caller graph for this function: