All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

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 (URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength) Base constructor
  WebSocketClientProtocolHandler (URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames) Base constructor
  WebSocketClientProtocolHandler (URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch) Base constructor
  WebSocketClientProtocolHandler (URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch, long handshakeTimeoutMillis) Base constructor
  WebSocketClientProtocolHandler (URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, long handshakeTimeoutMillis) Base constructor
  WebSocketClientProtocolHandler (URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, long handshakeTimeoutMillis) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, boolean handleCloseFrames) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames, long handshakeTimeoutMillis) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames, long handshakeTimeoutMillis, boolean withUTF8Validator) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, boolean handleCloseFrames, long handshakeTimeoutMillis) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, long handshakeTimeoutMillis) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientHandshaker handshaker, WebSocketClientProtocolConfig clientConfig) Base constructor
  WebSocketClientProtocolHandler (WebSocketClientProtocolConfig clientConfig) Base constructor

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  void	bind (ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) Called once a bind operation is made.
  protected WebSocketClientHandshakeException	buildHandshakeException (String message) Returns a WebSocketHandshakeException that depends on which client or server pipeline this handler belongs.
  void	close (ChannelHandlerContext ctx, ChannelPromise promise) Called once a close operation is made.
  void	connect (ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Called once a connect operation is made.
  protected void	decode (ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) Decode from one message to an other.
  void	deregister (ChannelHandlerContext ctx, ChannelPromise promise) Called once a deregister operation is made from the current registered EventLoop.
  void	disconnect (ChannelHandlerContext ctx, ChannelPromise promise) Called once a disconnect operation is made.
  void	exceptionCaught (ChannelHandlerContext ctx, Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
  void	flush (ChannelHandlerContext ctx) Called once a flush operation is made.
  void	handlerAdded (ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
  WebSocketClientHandshaker	handshaker () Returns the used handshaker
  void	read (ChannelHandlerContext ctx) Intercepts ChannelHandlerContext.read().
  void	write (ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Called once a write operation is made.

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

    acceptInboundMessage, channelRead, channelReadComplete

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

    channelActive, channelInactive, 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(WebSocketClientProtocolConfig clientConfig)

    Base constructor

    Parameters:

    clientConfig - Client protocol configuration.

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
     WebSocketClientProtocolConfig clientConfig)

    Base constructor

    Parameters:

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

    clientConfig - Client protocol configuration.

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(URI webSocketURL,
     WebSocketVersion version,
     String subprotocol,
     boolean allowExtensions,
     HttpHeaders customHeaders,
     int maxFramePayloadLength,
     boolean handleCloseFrames,
     boolean performMasking,
     boolean allowMaskMismatch)

    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

    performMasking - Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

    allowMaskMismatch - When set to true, frames which are not masked properly according to the standard will still be accepted.

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(URI webSocketURL,
     WebSocketVersion version,
     String subprotocol,
     boolean allowExtensions,
     HttpHeaders customHeaders,
     int maxFramePayloadLength,
     boolean handleCloseFrames,
     boolean performMasking,
     boolean allowMaskMismatch,
     long handshakeTimeoutMillis)

    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

    performMasking - Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

    allowMaskMismatch - When set to true, frames which are not masked properly according to the standard will still be accepted.

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(URI webSocketURL,
     WebSocketVersion version,
     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(URI webSocketURL,
     WebSocketVersion version,
     String subprotocol,
     boolean allowExtensions,
     HttpHeaders customHeaders,
     int maxFramePayloadLength,
     boolean handleCloseFrames,
     long handshakeTimeoutMillis)

    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

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(URI webSocketURL,
     WebSocketVersion version,
     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(URI webSocketURL,
     WebSocketVersion version,
     String subprotocol,
     boolean allowExtensions,
     HttpHeaders customHeaders,
     int maxFramePayloadLength,
     long handshakeTimeoutMillis)

    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

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

  • 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,
     boolean handleCloseFrames,
     long handshakeTimeoutMillis)

    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

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
     boolean handleCloseFrames,
     boolean dropPongFrames)

    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

    dropPongFrames - true if pong frames should not be forwarded

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
     boolean handleCloseFrames,
     boolean dropPongFrames,
     long handshakeTimeoutMillis)

    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

    dropPongFrames - true if pong frames should not be forwarded

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
     boolean handleCloseFrames,
     boolean dropPongFrames,
     long handshakeTimeoutMillis,
     boolean withUTF8Validator)

    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

    dropPongFrames - true if pong frames should not be forwarded

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

    withUTF8Validator - true if UTF8 validation of text frames should be enabled

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

  • WebSocketClientProtocolHandler

    public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
     long handshakeTimeoutMillis)

    Base constructor

    Parameters:

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

    handshakeTimeoutMillis - Handshake timeout in mills, when handshake timeout, will trigger user event WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT

• Method Detail

  • handshaker

    public WebSocketClientHandshaker handshaker()

    Returns the used handshaker

  • decode

    protected void decode(ChannelHandlerContext ctx,
     WebSocketFrame frame,
     List<Object> out)
     throws 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 decoder.

    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:

    Exception - is thrown if an error occurs

  • buildHandshakeException

    protected WebSocketClientHandshakeException buildHandshakeException(String message)

    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.

  • 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

  • close

    public void close(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a close operation is made.

    Specified by:

    close in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the close operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    Exception - thrown if an error occurs

  • write

    public void write(ChannelHandlerContext ctx,
     Object msg,
     ChannelPromise promise)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called

    Specified by:

    write in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the write operation is made

    msg - the message to write

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    Exception - thrown if an error occurs

  • bind

    public void bind(ChannelHandlerContext ctx,
     SocketAddress localAddress,
     ChannelPromise promise)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a bind operation is made.

    Specified by:

    bind in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the bind operation is made

    localAddress - the SocketAddress to which it should bound

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    Exception - thrown if an error occurs

  • connect

    public void connect(ChannelHandlerContext ctx,
     SocketAddress remoteAddress,
     SocketAddress localAddress,
     ChannelPromise promise)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a connect operation is made.

    Specified by:

    connect in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the connect operation is made

    remoteAddress - the SocketAddress to which it should connect

    localAddress - the SocketAddress which is used as source on connect

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    Exception - thrown if an error occurs

  • disconnect

    public void disconnect(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a disconnect operation is made.

    Specified by:

    disconnect in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the disconnect operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    Exception - thrown if an error occurs

  • deregister

    public void deregister(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a deregister operation is made from the current registered EventLoop.

    Specified by:

    deregister in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the close operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    Exception - thrown if an error occurs

  • read

    public void read(ChannelHandlerContext ctx)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Intercepts ChannelHandlerContext.read().

    Specified by:

    read in interface ChannelOutboundHandler

    Throws:

    Exception

  • flush

    public void flush(ChannelHandlerContext ctx)
     throws Exception 

    Description copied from interface: ChannelOutboundHandler
    Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

    Specified by:

    flush in interface ChannelOutboundHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the flush operation is made

    Throws:

    Exception - thrown if an error occurs

  • exceptionCaught

    public void exceptionCaught(ChannelHandlerContext ctx,
     Throwable cause)
     throws 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:

    Exception