All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class WebSocketClientProtocolHandler
extends MessageToMessageDecoder<WebSocketFrame>

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and Description
  static class	WebSocketClientProtocolHandler.ClientHandshakeStateEvent 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
  WebSocketClientProtocolHandler (java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength) Base constructor
  WebSocketClientProtocolHandler (java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, boolean handleCloseFrames) Base constructor

• 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.
  WebSocketClientHandshaker	handshaker () Returns the used handshaker

  • 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

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(java.net.URI webSocketURL,
     WebSocketVersion version,
     java.lang.String subprotocol,
     boolean allowExtensions,
     HttpHeaders customHeaders,
     int maxFramePayloadLength,
     boolean handleCloseFrames)

    Base constructor

    Parameters:

    webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

    version - Version of web socket specification to use to connect to the server

    subprotocol - Sub protocol request sent to the server.

    customHeaders - Map of custom headers to add to the client request

    maxFramePayloadLength - Maximum length of a frame's payload

    handleCloseFrames - true if close frames should not be forwarded and just close the channel

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(java.net.URI webSocketURL,
     WebSocketVersion version,
     java.lang.String subprotocol,
     boolean allowExtensions,
     HttpHeaders customHeaders,
     int maxFramePayloadLength)

    Base constructor

    Parameters:

    webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

    version - Version of web socket specification to use to connect to the server

    subprotocol - Sub protocol request sent to the server.

    customHeaders - Map of custom headers to add to the client request

    maxFramePayloadLength - Maximum length of a frame's payload

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
     boolean handleCloseFrames)

    Base constructor

    Parameters:

    handshaker - The WebSocketClientHandshaker which will be used to issue the handshake once the connection was established to the remote peer.

    handleCloseFrames - true if close frames should not be forwarded and just close the channel

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker)

    Base constructor

    Parameters:

    handshaker - The WebSocketClientHandshaker which will be used to issue the handshake once the connection was established to the remote peer.

• Method Detail

  • handshaker

    public WebSocketClientHandshaker handshaker()

    Returns the used handshaker

  • 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

  • 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

  • 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

    Overrides:

    exceptionCaught in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception