Module io.inverno.mod.http.server

Package io.inverno.mod.http.server.ws

Interface WebSocketExchange<A extends ExchangeContext>

Type Parameters:

A - the type of the exchange context

All Superinterfaces:

BaseWebSocketExchange<A>

All Known Subinterfaces:

Web2SocketExchange<A>

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

Represents a WebSocket exchange between a client and the server.

A WebSocket exchange is bidirectional and as a result provided an BaseWebSocketExchange.Inbound and an BaseWebSocketExchange.Outbound exposing WebSocket frames and messages respectively received and sent by the server.

A WebSocket exchange is created from the HTTP server exchange (see Exchange.webSocket(java.lang.String...)) once the WebSocket opening handshake has completed. It is processed in a WebSocketExchangeHandler specified in the WebSocket.

Since:

1.5

Author:

Jeremy Kuhn

See Also:

• WebSocket
• WebSocketExchangeHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.inverno.mod.http.base.ws.BaseWebSocketExchange

BaseWebSocketExchange.Inbound, BaseWebSocketExchange.Outbound

Method Summary

Modifier and Type	Method	Description
Request	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, finalizer, getSubProtocol, inbound, outbound

Method Details

request

Request request()

Returns the original HTTP upgrade request.

Returns:

the HTTP request