Package org.jboss.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
org.jboss.netty.example.http.websocket
package.
-
Class Summary Class Description BinaryWebSocketFrame Web Socket frame containing binary dataCloseWebSocketFrame Web Socket Frame for closing the connectionContinuationWebSocketFrame Web Socket continuation frame containing continuation text or binary data.PingWebSocketFrame Web Socket frame containing binary dataPongWebSocketFrame Web Socket frame containing binary dataTextWebSocketFrame Web Socket text frame with assumed UTF-8 encodingWebSocket00FrameDecoder DecodesChannelBuffer
s intoWebSocketFrame
s.WebSocket00FrameEncoder Encodes aWebSocketFrame
into aChannelBuffer
.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.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- 07WebSocketClientHandshaker08 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 Instances the appropriate handshake class to use for clientsWebSocketFrame Base class for web socket framesWebSocketFrameAggregator Handler that aggregate fragmented WebSocketFrame's.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- 07WebSocketServerHandshaker08 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 version draft-ietf-hybi-thewebsocketprotocol- 17).WebSocketServerHandshakerFactory Instances the appropriate handshake class to use for serversWebSocketServerProtocolHandler Handles WebSocket control frames (Close, Ping, Pong) and data frames (Text and Binary) are passed to the next handler in the pipeline.WebSocketServerProtocolHandshakeHandler Handles the HTTP handshake (the HTTP Upgrade request) -
Enum Summary Enum Description WebSocket08FrameDecoder.State WebSocketFrameType Type of web socket framesWebSocketVersion Versions of the web socket specification. -
Exception Summary Exception Description WebSocketHandshakeException Exception during handshaking process