Representa una sesión WebSocket activa. More...

Inheritance diagram for dev.rafex.ether.websocket.core.WebSocketSession:

Collaboration diagram for dev.rafex.ether.websocket.core.WebSocketSession:

Public Member Functions
Object	attribute (String name)
	Devuelve un atributo almacenado en esta sesión bajo el nombre dado.
void	attribute (String name, Object value)
	Almacena un atributo en esta sesión bajo el nombre dado.
CompletionStage< Void >	close (WebSocketCloseStatus status)
	Cierra la conexión WebSocket con el estado de cierre especificado.
String	headerFirst (String name)
	Devuelve el primer valor del header HTTP con el nombre especificado.
Map< String, List< String > >	headers ()
	Devuelve todos los headers HTTP de la petición de handshake.
String	id ()
	Devuelve el identificador único de esta sesión.
boolean	isOpen ()
	Indica si la conexión WebSocket sigue abierta.
String	path ()
	Devuelve el path de la petición WebSocket que originó esta sesión.
String	pathParam (String name)
	Devuelve el valor del parámetro de path con el nombre especificado.
Map< String, String >	pathParams ()
	Devuelve todos los parámetros de path extraídos durante el matching de ruta.
List< String >	queryAll (String name)
	Devuelve todos los valores del parámetro de query con el nombre especificado.
String	queryFirst (String name)
	Devuelve el primer valor del parámetro de query con el nombre especificado.
Map< String, List< String > >	queryParams ()
	Devuelve todos los parámetros de query de la URI de la conexión.
CompletionStage< Void >	sendBinary (ByteBuffer data)
	Envía un mensaje binario al cliente conectado.
CompletionStage< Void >	sendText (String text)
	Envía un mensaje de texto al cliente conectado.
String	subprotocol ()
	Devuelve el subprotocolo WebSocket negociado durante el handshake.

Detailed Description

Representa una sesión WebSocket activa.

Proporciona acceso a los metadatos de la conexión (identificador, path, headers, parámetros) y métodos para enviar mensajes y cerrar la sesión.

Definition at line 38 of file WebSocketSession.java.

Member Function Documentation

◆ attribute() [1/2]

Object dev.rafex.ether.websocket.core.WebSocketSession.attribute ( String name )

Devuelve un atributo almacenado en esta sesión bajo el nombre dado.

Parameters

name	clave del atributo

Returns: valor del atributo, o null si no existe

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ attribute() [2/2]

void dev.rafex.ether.websocket.core.WebSocketSession.attribute	(	String	name,
		Object	value )

Almacena un atributo en esta sesión bajo el nombre dado.

Parameters

name	clave del atributo
value	valor a almacenar

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ close()

CompletionStage< Void > dev.rafex.ether.websocket.core.WebSocketSession.close ( WebSocketCloseStatus status )

Cierra la conexión WebSocket con el estado de cierre especificado.

Parameters

status estado de cierre a enviar al cliente

Returns: CompletionStage que se completa cuando la conexión se cierra

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

References dev.rafex.ether.websocket.core.WebSocketCloseStatus().

Here is the call graph for this function:

◆ headerFirst()

String dev.rafex.ether.websocket.core.WebSocketSession.headerFirst ( String name )

Devuelve el primer valor del header HTTP con el nombre especificado.

Parameters

name	nombre del header (case-insensitive)

Returns: primer valor del header, o null si no existe

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ headers()

Map< String, List< String > > dev.rafex.ether.websocket.core.WebSocketSession.headers ( )

Devuelve todos los headers HTTP de la petición de handshake.

Returns: mapa de nombres de header a listas de valores

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ id()

String dev.rafex.ether.websocket.core.WebSocketSession.id ( )

Devuelve el identificador único de esta sesión.

Returns: cadena que identifica unívocamente la sesión

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ isOpen()

boolean dev.rafex.ether.websocket.core.WebSocketSession.isOpen ( )

Indica si la conexión WebSocket sigue abierta.

Returns: true si la sesión está activa; false si ya se cerró

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ path()

String dev.rafex.ether.websocket.core.WebSocketSession.path ( )

Devuelve el path de la petición WebSocket que originó esta sesión.

Returns: path de la URI de la conexión

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ pathParam()

String dev.rafex.ether.websocket.core.WebSocketSession.pathParam ( String name )

Devuelve el valor del parámetro de path con el nombre especificado.

Parameters

name	nombre del parámetro de path

Returns: valor del parámetro, o null si no existe

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ pathParams()

Map< String, String > dev.rafex.ether.websocket.core.WebSocketSession.pathParams ( )

Devuelve todos los parámetros de path extraídos durante el matching de ruta.

Returns: mapa inmutable de nombres de parámetro a sus valores

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ queryAll()

List< String > dev.rafex.ether.websocket.core.WebSocketSession.queryAll ( String name )

Devuelve todos los valores del parámetro de query con el nombre especificado.

Parameters

name	nombre del parámetro de query

Returns: lista de valores asociados; vacía si el parámetro no existe

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ queryFirst()

String dev.rafex.ether.websocket.core.WebSocketSession.queryFirst ( String name )

Devuelve el primer valor del parámetro de query con el nombre especificado.

Parameters

name	nombre del parámetro de query

Returns: primer valor del parámetro, o null si no existe

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ queryParams()

Map< String, List< String > > dev.rafex.ether.websocket.core.WebSocketSession.queryParams ( )

Devuelve todos los parámetros de query de la URI de la conexión.

Returns: mapa de nombres de parámetro a listas de valores

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ sendBinary()

CompletionStage< Void > dev.rafex.ether.websocket.core.WebSocketSession.sendBinary ( ByteBuffer data )

Envía un mensaje binario al cliente conectado.

Parameters

data	contenido binario a enviar

Returns: CompletionStage que se completa cuando el mensaje se envía

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ sendText()

CompletionStage< Void > dev.rafex.ether.websocket.core.WebSocketSession.sendText ( String text )

Envía un mensaje de texto al cliente conectado.

Parameters

text	contenido de texto a enviar

Returns: CompletionStage que se completa cuando el mensaje se envía

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

◆ subprotocol()

String dev.rafex.ether.websocket.core.WebSocketSession.subprotocol ( )

Devuelve el subprotocolo WebSocket negociado durante el handshake.

Returns: nombre del subprotocolo seleccionado, o cadena vacía si no se negoció

Implemented in dev.rafex.ether.websocket.jetty12.JettyWebSocketSession.

The documentation for this interface was generated from the following file:

ether-websocket-core/ether-websocket-core/src/main/java/dev/rafex/ether/websocket/core/WebSocketSession.java

Ether Framework Unified API docs for Ether modules

Public Member Functions

Detailed Description

Member Function Documentation

◆ attribute() [1/2]

◆ attribute() [2/2]

◆ close()

◆ headerFirst()

◆ headers()

◆ id()

◆ isOpen()

◆ path()

◆ pathParam()

◆ pathParams()

◆ queryAll()

◆ queryFirst()

◆ queryParams()

◆ sendBinary()

◆ sendText()

◆ subprotocol()