Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx

Encoder, decoder, handshakers and their related message types for Web Socket data frames.

This package supports different web socket specification versions (hence the X suffix). The specification current supported are:

• draft-ietf-hybi-thewebsocketprotocol-00
• draft-ietf-hybi-thewebsocketprotocol-07
• draft-ietf-hybi-thewebsocketprotocol-10
• RFC 6455 (originally draft-ietf-hybi-thewebsocketprotocol-17)

For the detailed instruction on adding add Web Socket support to your HTTP server, take a look into the WebSocketServerX example located in the io.netty5.example.http.websocket package.

Interface Summary

Interface	Description
WebSocketFrameDecoder	Marker interface which all WebSocketFrame decoders need to implement.
WebSocketFrameEncoder	Marker interface which all WebSocketFrame encoders need to implement.

Class Summary

Class	Description
BinaryWebSocketFrame	Web Socket frame containing binary data.
CloseWebSocketFrame	Web Socket Frame for closing the connection.
ContinuationWebSocketFrame	Web Socket continuation frame containing continuation text or binary data.
PingWebSocketFrame	Web Socket frame containing binary data.
PongWebSocketFrame	Web Socket frame containing binary data.
TextWebSocketFrame	Web Socket text frame.
Utf8FrameValidator
WebSocket13FrameDecoder	Decodes a web socket frame from wire protocol version 13 format.
WebSocket13FrameEncoder	Encodes a web socket frame into wire protocol version 13 format.
WebSocketChunkedInput	A ChunkedInput that fetches data chunk by chunk for use with WebSocket chunked transfers.
WebSocketClientHandshakeCompletionEvent	A websocket handshake was completed on the client-side.
WebSocketClientHandshaker	Base class for web socket client handshake implementations
WebSocketClientHandshaker13	Performs client side opening and closing handshakes for web socket specification version websocketprotocol-v13
WebSocketClientHandshakerFactory	Creates a new WebSocketClientHandshaker of desired protocol version.
WebSocketClientProtocolConfig	WebSocket server configuration.
WebSocketClientProtocolConfig.Builder
WebSocketClientProtocolHandler	This handler does all the heavy lifting for you to run a websocket client.
WebSocketCloseStatus	WebSocket status codes specified in RFC-6455.
WebSocketDecoderConfig	Frames decoder configuration.
WebSocketDecoderConfig.Builder
WebSocketFrame	Base class for web socket frames.
WebSocketFrameAggregator	Handler that aggregate fragmented WebSocketFrame's.
WebSocketHandshakeCompletionEvent	ProtocolEvent that indicate the completion of a websocket handshake.
WebSocketScheme	Defines the common schemes used for the WebSocket protocol as defined by rfc6455.
WebSocketServerHandshakeCompletionEvent	A websocket handshake was completed on the server-side.
WebSocketServerHandshaker	Base class for server side web socket opening and closing handshakes
WebSocketServerHandshaker13	Performs server side opening and closing handshakes for RFC 6455 (originally web socket specification draft-ietf-hybi-thewebsocketprotocol-17).
WebSocketServerHandshakerFactory	Auto-detects the version of the Web Socket protocol in use and creates a new proper WebSocketServerHandshaker.
WebSocketServerProtocolConfig	WebSocket server configuration.
WebSocketServerProtocolConfig.Builder
WebSocketServerProtocolHandler	This handler does all the heavy lifting for you to run a websocket server.

Enum Summary

Enum	Description
WebSocketVersion	Versions of the web socket specification.

Exception Summary

Exception	Description
CorruptedWebSocketFrameException	An DecoderException which is thrown when the received WebSocketFrame data could not be decoded by an inbound handler.
WebSocketClientHandshakeException	Client exception during handshaking process.
WebSocketHandshakeException	Exception during handshaking process
WebSocketHandshakeTimeoutException	WebSocketHandshakeException that is used when a handshake failed due a configured timeout.
WebSocketServerHandshakeException	Server exception during handshaking process.