This handler does all the heavy lifting for you to run a websocket server. It takes care of websocket handshaking as well as processing of control frames (Close, Ping, Pong). Text and Binary data frames are passed to the next handler in the pipeline (implemented by you) for processing. See io.netty.example.http.websocketx.html5.WebSocketServer for usage. The implementation of this handler assumes that you just want to run a websocket server and not process other types HTTP requests (like GET and POST). If you wish to support both HTTP requests and websockets in the one server, refer to the io.netty.example.http.websocketx.server.WebSocketServer example. To know once a handshake was done you can intercept the ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object) and check if the event was instance of HandshakeComplete, the event will contain extra information about the handshake such as the request and selected subprotocol.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WebSocketServerProtocolHandler.HandshakeComplete The Handshake was completed successfully and the channel was upgraded to websockets.
public static enum	WebSocketServerProtocolHandler.ServerHandshakeStateEvent Events that are fired to notify about handshake status

Modifier and Type	Field and Description
private static final AttributeKey<WebSocketServerHandshaker>	HANDSHAKER_ATTR_KEY
private final WebSocketServerProtocolConfig	serverConfig

Constructor Summary

Access	Constructor and Description
public	WebSocketServerProtocolHandler(WebSocketServerProtocolConfig Server protocol configuration. serverConfig) Base constructor
public	WebSocketServerProtocolHandler(String websocketPath)
public	WebSocketServerProtocolHandler(String websocketPath, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, boolean checkStartsWith)
public	WebSocketServerProtocolHandler(String websocketPath, boolean checkStartsWith, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, boolean dropPongFrames)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, boolean dropPongFrames, long handshakeTimeoutMillis)
public	WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean checkStartsWith, boolean dropPongFrames, long handshakeTimeoutMillis, WebSocketDecoderConfig decoderConfig)

Method Summary

Modifier and Type	Method and Description
protected WebSocketServerHandshakeException	buildHandshakeException(String message) Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.buildHandshakeException. Returns a `WebSocketHandshakeException` that depends on which client or server pipeline this handler belongs.
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, WebSocketFrame the message to decode to an other one frame, List<Object> the `List` to which decoded messages should be added out) Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.decode. Decode from one message to an other.
public void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Gets called if a `Throwable` was thrown.
pack-priv static WebSocketServerHandshaker	getHandshaker(Channel channel)
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
pack-priv static void	setHandshaker(Channel channel, WebSocketServerHandshaker handshaker)

Inherited from io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler:: bind close closeSent connect deregister disconnect flush read write

Field Detail

HANDSHAKER_ATTR_KEY	back to summary
private static final AttributeKey<WebSocketServerHandshaker> HANDSHAKER_ATTR_KEY

serverConfig	back to summary
private final WebSocketServerProtocolConfig serverConfig

Constructor Detail

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(WebSocketServerProtocolConfig serverConfig) Base constructor Parameters serverConfig:WebSocketServerProtocolConfig Server protocol configuration.

WebSocketServerProtocolHandler

back to summary

public WebSocketServerProtocolHandler(WebSocketServerProtocolConfig serverConfig)

Base constructor

Parameters

serverConfig:WebSocketServerProtocolConfig: Server protocol configuration.

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, boolean checkStartsWith)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, boolean checkStartsWith, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, boolean dropPongFrames)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, boolean dropPongFrames, long handshakeTimeoutMillis)

WebSocketServerProtocolHandler	back to summary
public WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean checkStartsWith, boolean dropPongFrames, long handshakeTimeoutMillis, WebSocketDecoderConfig decoderConfig)

Method Detail

buildHandshakeException back to summary

buildHandshakeException	back to summary
protected WebSocketServerHandshakeException buildHandshakeException(String message) Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.buildHandshakeException. Doc from io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.buildHandshakeException. Returns a `WebSocketHandshakeException` that depends on which client or server pipeline this handler belongs. Should be overridden in implementation otherwise a default exception is used. Annotations @Override

protected WebSocketServerHandshakeException buildHandshakeException(String message)

Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.buildHandshakeException.

Doc from io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.buildHandshakeException.

Returns a WebSocketHandshakeException that depends on which client or server pipeline this handler belongs. Should be overridden in implementation otherwise a default exception is used.

Annotations

@Override

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) throws Exception Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.decode. Doc from io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other. This method will be called for each written message that can be handled by this decoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to frame:WebSocketFrame the message to decode to an other one out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) throws Exception

Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.decode.

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
frame:WebSocketFrame: the message to decode to an other one
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

exceptionCaught back to summary

exceptionCaught	back to summary
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Doc from io.netty.channel.ChannelHandler.exceptionCaught. Gets called if a `Throwable` was thrown. Annotations @Override

public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception

Overrides io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler.exceptionCaught.

Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught.

Doc from io.netty.channel.ChannelHandler.exceptionCaught.

Gets called if a Throwable was thrown.

Annotations

@Override

getHandshaker	back to summary
pack-priv static WebSocketServerHandshaker getHandshaker(Channel channel)

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Doc from io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx)

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

setHandshaker	back to summary
pack-priv static void setHandshaker(Channel channel, WebSocketServerHandshaker handshaker)

io.netty.handler.codec.http.websocketx back to summary

public final Class WebSocketServerProtocolHandler.HandshakeComplete

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler.HandshakeComplete

The Handshake was completed successfully and the channel was upgraded to websockets.

Field Summary

Modifier and Type	Field and Description
private final HttpHeaders	requestHeaders
private final String	requestUri
private final String	selectedSubprotocol

Constructor Summary

Access	Constructor and Description
public	HandshakeComplete(String requestUri, HttpHeaders requestHeaders, String selectedSubprotocol)

Method Summary

Modifier and Type	Method and Description
public HttpHeaders	requestHeaders()
public String	requestUri()
public String	selectedSubprotocol()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

requestHeaders	back to summary
private final HttpHeaders requestHeaders

requestUri	back to summary
private final String requestUri

selectedSubprotocol	back to summary
private final String selectedSubprotocol

Constructor Detail

HandshakeComplete	back to summary
public HandshakeComplete(String requestUri, HttpHeaders requestHeaders, String selectedSubprotocol)

Method Detail

requestHeaders	back to summary
public HttpHeaders requestHeaders()

requestUri	back to summary
public String requestUri()

selectedSubprotocol	back to summary
public String selectedSubprotocol()

io.netty.handler.codec.http.websocketx back to summary

public final Enum WebSocketServerProtocolHandler.ServerHandshakeStateEvent

Class Inheritance

extends Enum<WebSocketServerProtocolHandler.ServerHandshakeStateEvent>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler.ServerHandshakeStateEvent

Events that are fired to notify about handshake status

Field Summary

Modifier and Type	Field and Description
public static final WebSocketServerProtocolHandler.ServerHandshakeStateEvent	HANDSHAKE_COMPLETE The Handshake was completed successfully and the channel was upgraded to websockets.
public static final WebSocketServerProtocolHandler.ServerHandshakeStateEvent	HANDSHAKE_TIMEOUT The Handshake was timed out

Constructor Summary

Access	Constructor and Description
private	ServerHandshakeStateEvent()

Method Summary

Modifier and Type	Method and Description
public static WebSocketServerProtocolHandler.ServerHandshakeStateEvent	valueOf(String name)
public static WebSocketServerProtocolHandler.ServerHandshakeStateEvent[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

HANDSHAKE_COMPLETE	back to summary
public static final WebSocketServerProtocolHandler.ServerHandshakeStateEvent HANDSHAKE_COMPLETE Deprecated in favor of `HandshakeComplete` class, it provides extra information about the handshake The Handshake was completed successfully and the channel was upgraded to websockets. Annotations @Deprecated

HANDSHAKE_TIMEOUT	back to summary
public static final WebSocketServerProtocolHandler.ServerHandshakeStateEvent HANDSHAKE_TIMEOUT The Handshake was timed out

Constructor Detail

ServerHandshakeStateEvent	back to summary
private ServerHandshakeStateEvent()

Method Detail

valueOf	back to summary
public static WebSocketServerProtocolHandler.ServerHandshakeStateEvent valueOf(String name)

values	back to summary
public static WebSocketServerProtocolHandler.ServerHandshakeStateEvent[] values()

public Class WebSocketServerProtocolHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class WebSocketServerProtocolHandler.HandshakeComplete

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum WebSocketServerProtocolHandler.ServerHandshakeStateEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail