Top Description Interfaces Classes Enums
[default module]

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:

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

Modifier and TypeInterface and Description
public interface
WebSocketFrameDecoder

Marker interface which all WebSocketFrame decoders need to implement.

public interface
WebSocketFrameEncoder

Marker interface which all WebSocketFrame encoders need to implement.

Class Summary

Modifier and TypeClass and Description
public class
BinaryWebSocketFrame

Web Socket frame containing binary data.

public class
CloseWebSocketFrame

Web Socket Frame for closing the connection.

public class
ContinuationWebSocketFrame

Web Socket continuation frame containing continuation text or binary data.

public class
CorruptedWebSocketFrameException

An DecoderException which is thrown when the received WebSocketFrame data could not be decoded by an inbound handler.

public class
PingWebSocketFrame

Web Socket frame containing binary data.

public class
PongWebSocketFrame

Web Socket frame containing binary data.

public class
TextWebSocketFrame

Web Socket text frame.

public class
pack-priv class
Utf8Validator

Checks UTF8 bytes for validity

public class
public class
public class
WebSocket07FrameDecoder

Decodes a web socket frame from wire protocol version 7 format.

public class
WebSocket07FrameEncoder

Encodes a web socket frame into wire protocol version 7 format.

public class
WebSocket08FrameDecoder

Decodes a web socket frame from wire protocol version 8 format.

public class
WebSocket08FrameEncoder

Encodes a web socket frame into wire protocol version 8 format.

public class
WebSocket13FrameDecoder

Decodes a web socket frame from wire protocol version 13 format.

public class
WebSocket13FrameEncoder

Encodes a web socket frame into wire protocol version 13 format.

public class
WebSocketChunkedInput

A ChunkedInput that fetches data chunk by chunk for use with WebSocket chunked transfers.

public class
WebSocketClientHandshakeException

Client exception during handshaking process.

public abstract class
WebSocketClientHandshaker

Base class for web socket client handshake implementations

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

public class
WebSocketClientHandshaker07

Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10

public class
WebSocketClientHandshaker08

Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10

public class
WebSocketClientHandshaker13

Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 17

public class
WebSocketClientHandshakerFactory

Creates a new WebSocketClientHandshaker of desired protocol version.

public class
WebSocketClientProtocolConfig

WebSocket server configuration.

public class
WebSocketClientProtocolHandler

This handler does all the heavy lifting for you to run a websocket client.

pack-priv class
public class
WebSocketCloseStatus

WebSocket status codes specified in RFC-6455.

public class
WebSocketDecoderConfig

Frames decoder configuration.

public abstract class
WebSocketFrame

Base class for web socket frames.

public class
WebSocketFrameAggregator

Handler that aggregate fragmented WebSocketFrame's.

public class
WebSocketHandshakeException

Exception during handshaking process

pack-priv abstract class
public class
WebSocketScheme

Defines the common schemes used for the WebSocket protocol as defined by rfc6455.

public class
WebSocketServerHandshakeException

Server exception during handshaking process.

public abstract class
WebSocketServerHandshaker

Base class for server side web socket opening and closing handshakes

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

public class
WebSocketServerHandshaker07

Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10

public class
WebSocketServerHandshaker08

Performs server side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10

public class
WebSocketServerHandshaker13

Performs server side opening and closing handshakes for RFC 6455 (originally web socket specification draft-ietf-hybi-thewebsocketprotocol-17).

public class
WebSocketServerHandshakerFactory

Auto-detects the version of the Web Socket protocol in use and creates a new proper WebSocketServerHandshaker.

public class
WebSocketServerProtocolConfig

WebSocket server configuration.

public class
WebSocketServerProtocolHandler

This handler does all the heavy lifting for you to run a websocket server.

pack-priv class
WebSocketServerProtocolHandshakeHandler

Handles the HTTP handshake (the HTTP Upgrade request) for WebSocketServerProtocolHandler.

pack-priv class
WebSocketUtil

A utility class mainly for use by web sockets

Enum Summary

Modifier and TypeEnum and Description
public enum
WebSocketVersion

Versions of the web socket specification.