Module io.inverno.mod.http.client

Package io.inverno.mod.http.client.ws

Interface WebSocketExchange<A extends ExchangeContext>

Type Parameters:

A - the type of the exchange context

All Superinterfaces:

BaseWebSocketExchange<A>

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

Represents a WebSocket exchange between the client and an endpoint.

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 client.

A WebSocket exchange is created when the WebSocket exchange publisher returned by Exchange.webSocket() is subscribed.

Since:

1.6

Author:

Jeremy Kuhn

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
BaseRequest	request()	Returns the original HTTP upgrade request sent to the endpoint.

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

close, close, close, close, close, close, context, getSubProtocol, inbound, outbound

Method Details

request

BaseRequest request()

Returns the original HTTP upgrade request sent to the endpoint.

Returns:

the HTTP request