# Package org.jboss.netty.handler.codec.http.websocketx

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

See: Description

- 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 with assumed UTF-8 encoding
  WebSocket00FrameDecoder | Decodes `ChannelBuffer`s into `WebSocketFrame`s.
  WebSocket00FrameEncoder | Encodes a `WebSocketFrame` into a `ChannelBuffer`.
  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 implementations
  WebSocketClientHandshaker00 | Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00 A very large portion of this code was taken from the Netty 3.2 HTTP example.
  WebSocketClientHandshaker08 | Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10
  WebSocketClientHandshaker13 | Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 17
  WebSocketClientHandshakerFactory | Instances the appropriate handshake class to use for clients
  WebSocketFrame | Base class for web socket frames
  WebSocketServerHandshaker | Base class for server side web socket opening and closing handshakes
  WebSocketServerHandshaker00 | Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00 A very large portion of this code was taken from the Netty 3.2 HTTP example.
  WebSocketServerHandshaker08 | Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10
  WebSocketServerHandshaker13 | 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 servers

- Enum Summary
  Enum | Description
  --- | ---
  WebSocket08FrameDecoder.State |
  WebSocketFrameType | Type of web socket frames
  WebSocketVersion | Versions of the web socket specification.

- Exception Summary
  Exception | Description
  --- | ---
  WebSocketHandshakeException | Exception during handshaking process

## Package org.jboss.netty.handler.codec.http.websocketx Description

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

Copyright © 2008-2012 The Netty Project. All Rights Reserved.