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.
-
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 WebSocket00FrameDecoder DecodesByteBuf
s intoWebSocketFrame
s.WebSocket00FrameEncoder Encodes aWebSocketFrame
into aByteBuf
.WebSocket07FrameDecoder Decodes a web socket frame from wire protocol version 7 format.WebSocket07FrameEncoder Encodes a web socket frame into wire protocol version 7 format.WebSocket08FrameDecoder Decodes a web socket frame from wire protocol version 8 format.WebSocket08FrameEncoder Encodes a web socket frame into wire protocol version 8 format.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 AChunkedInput
that fetches data chunk by chunk for use with WebSocket chunked transfers.WebSocketClientHandshaker Base class for web socket client handshake implementationsWebSocketClientHandshaker00 Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00WebSocketClientHandshaker07 Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10WebSocketClientHandshaker08 Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10WebSocketClientHandshaker13 Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 17WebSocketClientHandshakerFactory Creates a newWebSocketClientHandshaker
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.WebSocketScheme Defines the common schemes used for the WebSocket protocol as defined by rfc6455.WebSocketServerHandshaker Base class for server side web socket opening and closing handshakesWebSocketServerHandshaker00 Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00WebSocketServerHandshaker07 Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10WebSocketServerHandshaker08 Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10WebSocketServerHandshaker13 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 properWebSocketServerHandshaker
.WebSocketServerProtocolConfig WebSocket server configuration.WebSocketServerProtocolConfig.Builder WebSocketServerProtocolHandler This handler does all the heavy lifting for you to run a websocket server.WebSocketServerProtocolHandler.HandshakeComplete The Handshake was completed successfully and the channel was upgraded to websockets. -
Enum Summary Enum Description WebSocketClientProtocolHandler.ClientHandshakeStateEvent Events that are fired to notify about handshake statusWebSocketServerProtocolHandler.ServerHandshakeStateEvent Events that are fired to notify about handshake statusWebSocketVersion Versions of the web socket specification. -
Exception Summary Exception Description CorruptedWebSocketFrameException AnDecoderException
which is thrown when the receivedWebSocketFrame
data could not be decoded by an inbound handler.WebSocketClientHandshakeException Client exception during handshaking process.WebSocketHandshakeException Exception during handshaking processWebSocketServerHandshakeException Server exception during handshaking process.