Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx

Class WebSocketClientProtocolHandler

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

io.netty5.handler.codec.MessageToMessageDecoder<WebSocketFrame>

io.netty5.handler.codec.http.websocketx.WebSocketClientProtocolHandler

All Implemented Interfaces:

ChannelHandler

public class WebSocketClientProtocolHandler
extends MessageToMessageDecoder<WebSocketFrame>

This handler does all the heavy lifting for you to run a websocket client. It takes care of websocket handshaking as well as processing of Ping, Pong frames. Text and Binary data frames are passed to the next handler in the pipeline (implemented by you) for processing. Also the close frame is passed to the next handler as you may want inspect it before close the connection if the handleCloseFrames is false, default is true. This implementation will establish the websocket connection once the connection to the remote server was complete. To know once a handshake was done you can intercept the ChannelHandler.channelInboundEvent(ChannelHandlerContext, Object) and check if the event was of type WebSocketHandshakeCompletionEvent.

Constructor Summary

Constructors

Constructor	Description
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, long handshakeTimeoutMillis)	Base constructor
WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, long handshakeTimeoutMillis)	Base constructor
WebSocketClientProtocolHandler(WebSocketClientProtocolConfig clientConfig)	Base constructor
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

Method Summary

Modifier and Type	Method	Description
protected WebSocketClientHandshakeException	buildHandshakeException(String message)	Returns a WebSocketHandshakeException that depends on which client or server pipeline this handler belongs.
void	channelExceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Gets called if a Throwable was thrown when handling inbound events.
Future<Void>	close(ChannelHandlerContext ctx)	Called once a close operation is made.
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame msg)	Decode from one message to another.
protected void	decodeAndClose(ChannelHandlerContext ctx, WebSocketFrame frame)	Decode from one message to another.
void	handlerAdded(ChannelHandlerContext ctx)	Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.
WebSocketClientHandshaker	handshaker()	Returns the used handshaker
Future<Void>	write(ChannelHandlerContext ctx, Object msg)	Called once a write operation is made.

Methods inherited from class io.netty5.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelInactive, channelInboundEvent, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, connect, deregister, disconnect, flush, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown

Constructor Detail

WebSocketClientProtocolHandler

public WebSocketClientProtocolHandler(WebSocketClientProtocolConfig clientConfig)

Base constructor

Parameters:

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 an inbound channel event WebSocketClientHandshakeCompletionEvent with a WebSocketHandshakeTimeoutException.

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 an inbound channel event WebSocketClientHandshakeCompletionEvent with a WebSocketHandshakeTimeoutException.

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 an inbound channel event WebSocketClientHandshakeCompletionEvent with a WebSocketHandshakeTimeoutException.

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 an inbound channel event WebSocketClientHandshakeCompletionEvent with a WebSocketHandshakeTimeoutException.

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 an inbound channel event WebSocketClientHandshakeCompletionEvent with a WebSocketHandshakeTimeoutException.

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 an inbound channel event WebSocketClientHandshakeCompletionEvent with a WebSocketHandshakeTimeoutException.

Method Detail

handshaker

public WebSocketClientHandshaker handshaker()

Returns the used handshaker

decodeAndClose

protected void decodeAndClose(ChannelHandlerContext ctx,
                              WebSocketFrame frame)
                       throws Exception

Description copied from class: MessageToMessageDecoder

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

The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method.

Subclasses that wish to have incoming messages automatically disposed of should instead override the MessageToMessageDecoder.decodeAndClose(ChannelHandlerContext, Object) method.

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

frame - the message to decode to another one

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 interface: ChannelHandler

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

decode

protected void decode(ChannelHandlerContext ctx,
                      WebSocketFrame msg)
               throws Exception

Description copied from class: MessageToMessageDecoder

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

The message will be disposed of after this call.

Subclasses that wish to sometimes pass messages through, should instead override the MessageToMessageDecoder.decodeAndClose(ChannelHandlerContext, Object) method.

Overrides:

decode in class MessageToMessageDecoder<WebSocketFrame>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to another one

Throws:

Exception - is thrown if an error occurs

close

public Future<Void> close(ChannelHandlerContext ctx)

Description copied from interface: ChannelHandler

Called once a close operation is made.

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

Returns:

the Future which will be notified once the operation completes.

write

public Future<Void> write(ChannelHandlerContext ctx,
                          Object msg)

Description copied from interface: ChannelHandler

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.

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

Returns:

the Future which will be notified once the operation completes.

channelExceptionCaught

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

Description copied from interface: ChannelHandler

Gets called if a Throwable was thrown when handling inbound events.

Throws:

Exception