Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface Web2SocketExchange<A extends ExchangeContext>

Type Parameters:

A - the type of the exchange context

All Superinterfaces:

BaseWebSocketExchange<A>, WebSocketExchange<A>

public interface Web2SocketExchange<A extends ExchangeContext>
extends WebSocketExchange<A>

A WebSocket exchange that extends the HTTP server WebSocketExchange with features for the Web.

It supports inbound and outbound message decoding and encoding based on the negotiated subprotocol which is interpreted as a compact application media types (see MediaTypes.normalizeApplicationMediaType(java.lang.String)).

Since:

1.5

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Web2SocketExchange.Inbound	Extends BaseWebSocketExchange.Inbound to support WebSocket message decoding.
static interface	Web2SocketExchange.Outbound	Extends BaseWebSocketExchange.Outbound to support WebSocket message encoding.

Method Summary

Modifier and Type	Method	Description
Web2SocketExchange<A>	finalizer(Mono<Void> finalizer)	Specifies a finalizer to the WebSocket exchange which completes once the exchange is closed.
Web2SocketExchange.Inbound	inbound()	Returns the inbound part of the WebSocket exchange.
Web2SocketExchange.Outbound	outbound()	Returns the outbound part of the WebSocket exchange.
WebRequest	request()	Returns the original HTTP upgrade request.

Methods inherited from interface io.inverno.mod.http.base.ws.BaseWebSocketExchange

close, close, close, close, close, close, context, getSubProtocol

Method Details

request

WebRequest request()

Description copied from interface: WebSocketExchange

Returns the original HTTP upgrade request.

Specified by:

request in interface WebSocketExchange<A extends ExchangeContext>

Returns:

the HTTP request

finalizer

Web2SocketExchange<A> finalizer(Mono<Void> finalizer)

Description copied from interface: BaseWebSocketExchange

Specifies a finalizer to the WebSocket exchange which completes once the exchange is closed.

Specified by:

finalizer in interface BaseWebSocketExchange<A extends ExchangeContext>

Parameters:

finalizer - a finalizer

Returns:

the WebSocket exchange

inbound

Web2SocketExchange.Inbound inbound()

Description copied from interface: BaseWebSocketExchange

Returns the inbound part of the WebSocket exchange.

This basically corresponds to the stream of WebSocket frames received by the server from the client or by the client from the server.

Specified by:

inbound in interface BaseWebSocketExchange<A extends ExchangeContext>

Returns:

the inbound part

outbound

Web2SocketExchange.Outbound outbound()

Description copied from interface: BaseWebSocketExchange

Returns the outbound part of the WebSocket exchange.

This basically corresponds to the stream of WebSocket frames sent by the server to the client or by the client to the server.

Specified by:

outbound in interface BaseWebSocketExchange<A extends ExchangeContext>

Returns:

the outbound part