Package io.netty.handler.codec.http.websocketx
package io.netty.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.netty.example.http.websocket
package.
-
ClassDescriptionWeb Socket frame containing binary data.Web Socket Frame for closing the connection.Web Socket continuation frame containing continuation text or binary data.An
DecoderException
which is thrown when the receivedWebSocketFrame
data could not be decoded by an inbound handler.Web Socket frame containing binary data.Web Socket frame containing binary data.Web Socket text frame.Checks UTF8 bytes for validityDecodesByteBuf
s intoWebSocketFrame
s.Encodes aWebSocketFrame
into aByteBuf
.Decodes a web socket frame from wire protocol version 7 format.Encodes a web socket frame into wire protocol version 7 format.Decodes a web socket frame from wire protocol version 8 format.Encodes a web socket frame into wire protocol version 8 format.Decodes a web socket frame from wire protocol version 13 format.Encodes a web socket frame into wire protocol version 13 format.AChunkedInput
that fetches data chunk by chunk for use with WebSocket chunked transfers.Client exception during handshaking process.Base class for web socket client handshake implementationsPerforms client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 17Creates a newWebSocketClientHandshaker
of desired protocol version.WebSocket server configuration.This handler does all the heavy lifting for you to run a websocket client.Events that are fired to notify about handshake statusWebSocket status codes specified in RFC-6455.Frames decoder configuration.Base class for web socket frames.Handler that aggregate fragmented WebSocketFrame's.Marker interface which all WebSocketFrame decoders need to implement.Marker interface which all WebSocketFrame encoders need to implement.Exception during handshaking processDefines the common schemes used for the WebSocket protocol as defined by rfc6455.Server exception during handshaking process.Base class for server side web socket opening and closing handshakesPerforms server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10Performs server side opening and closing handshakes for RFC 6455 (originally web socket specification draft-ietf-hybi-thewebsocketprotocol-17).Auto-detects the version of the Web Socket protocol in use and creates a new properWebSocketServerHandshaker
.WebSocket server configuration.This handler does all the heavy lifting for you to run a websocket server.The Handshake was completed successfully and the channel was upgraded to websockets.Events that are fired to notify about handshake statusHandles the HTTP handshake (the HTTP Upgrade request) forWebSocketServerProtocolHandler
.A utility class mainly for use by web socketsVersions of the web socket specification.