All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class WebSocketServerProtocolHandler
extends MessageToMessageDecoder<WebSocketFrame>

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and Description
  static class	WebSocketServerProtocolHandler.ServerHandshakeStateEvent Events that are fired to notify about handshake status

  • Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

    ChannelHandler.Sharable

• Constructor Summary

  Constructors

  Constructor and Description
  WebSocketServerProtocolHandler (java.lang.String websocketPath)
  WebSocketServerProtocolHandler (java.lang.String websocketPath, boolean checkStartsWith)
  WebSocketServerProtocolHandler (java.lang.String websocketPath, java.lang.String subprotocols)
  WebSocketServerProtocolHandler (java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions)
  WebSocketServerProtocolHandler (java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize)
  WebSocketServerProtocolHandler (java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean checkStartsWith)

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  protected void	decode (ChannelHandlerContext ctx, WebSocketFrame frame, java.util.List<java.lang.Object> out) Decode from one message to an other.
  void	exceptionCaught (ChannelHandlerContext ctx, java.lang.Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
  void	handlerAdded (ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

  • Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

    acceptInboundMessage, channelRead

  • Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

    channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

  • Methods inherited from class io.netty.channel.ChannelHandlerAdapter

    ensureNotSharable, handlerRemoved, isSharable

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Methods inherited from interface io.netty.channel.ChannelHandler

    handlerRemoved

• Constructor Detail

  • WebSocketServerProtocolHandler

    public WebSocketServerProtocolHandler(java.lang.String websocketPath)

  • WebSocketServerProtocolHandler

    public WebSocketServerProtocolHandler(java.lang.String websocketPath,
     boolean checkStartsWith)

  • WebSocketServerProtocolHandler

    public WebSocketServerProtocolHandler(java.lang.String websocketPath,
     java.lang.String subprotocols)

  • WebSocketServerProtocolHandler

    public WebSocketServerProtocolHandler(java.lang.String websocketPath,
     java.lang.String subprotocols,
     boolean allowExtensions)

  • WebSocketServerProtocolHandler

    public WebSocketServerProtocolHandler(java.lang.String websocketPath,
     java.lang.String subprotocols,
     boolean allowExtensions,
     int maxFrameSize)

  • WebSocketServerProtocolHandler

    public WebSocketServerProtocolHandler(java.lang.String websocketPath,
     java.lang.String subprotocols,
     boolean allowExtensions,
     int maxFrameSize,
     boolean checkStartsWith)

• Method Detail

  • handlerAdded

    public void handlerAdded(ChannelHandlerContext ctx)

    Description copied from class: ChannelHandlerAdapter
    Do nothing by default, sub-classes may override this method.

    Specified by:

    handlerAdded in interface ChannelHandler

    Overrides:

    handlerAdded in class ChannelHandlerAdapter

  • decode

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

    Description copied from class: MessageToMessageDecoder
    Decode from one message to an other. This method will be called for each written message that can be handled by this encoder.

    Parameters:

    ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

    frame - the message to decode to an other one

    out - the List to which decoded messages should be added

    Throws:

    java.lang.Exception - is thrown if an error occurs

  • exceptionCaught

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

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    exceptionCaught in interface ChannelHandler

    Specified by:

    exceptionCaught in interface ChannelInboundHandler

    Throws:

    java.lang.Exception