Module io.inverno.mod.web.base

Package io.inverno.mod.web.base.ws

Interface BaseWeb2SocketExchange<A extends ExchangeContext>

Type Parameters:

A - the exchange context type

All Superinterfaces:

BaseWebSocketExchange<A>

All Known Subinterfaces:

Web2SocketExchange<A>, Web2SocketExchange<A>

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

Base Web WebSocket exchange supporting message encoding and decoding.

Since:

1.12

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
BaseWeb2SocketExchange.Inbound	inbound()	Returns the inbound part of the WebSocket exchange.
BaseWeb2SocketExchange.Outbound	outbound()	Returns the outbound part of the WebSocket exchange.

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

close, close, close, close, close, close, context, getSubprotocol

Method Details

inbound

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

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