Class WebSocketClientProtocolHandler
java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.MessageToMessageDecoder<WebSocketFrame>
io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler
io.netty.handler.codec.http.websocketx.WebSocketClientProtocolHandler
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
,ChannelOutboundHandler
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
ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)
and check if the event was of type
WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_ISSUED
or WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_COMPLETE
.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Events that are fired to notify about handshake statusNested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final WebSocketClientProtocolConfig
private final WebSocketClientHandshaker
-
Constructor Summary
ConstructorsConstructorDescriptionBase constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, boolean handleCloseFrames) Base constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames) Base constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames, long handshakeTimeoutMillis) Base constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames, long handshakeTimeoutMillis, boolean withUTF8Validator) Base constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, long handshakeTimeoutMillis) Base constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, long handshakeTimeoutMillis) Base constructorWebSocketClientProtocolHandler
(WebSocketClientHandshaker handshaker, WebSocketClientProtocolConfig clientConfig) Base constructorWebSocketClientProtocolHandler
(WebSocketClientProtocolConfig clientConfig) Base constructorWebSocketClientProtocolHandler
(URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength) Base constructorWebSocketClientProtocolHandler
(URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames) Base constructorWebSocketClientProtocolHandler
(URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch) Base constructorWebSocketClientProtocolHandler
(URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch, long handshakeTimeoutMillis) Base constructorWebSocketClientProtocolHandler
(URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, long handshakeTimeoutMillis) Base constructorWebSocketClientProtocolHandler
(URI webSocketURL, WebSocketVersion version, String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, long handshakeTimeoutMillis) Base constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected WebSocketClientHandshakeException
buildHandshakeException
(String message) Returns aWebSocketHandshakeException
that depends on which client or server pipeline this handler belongs.protected void
decode
(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) Decode from one message to an other.void
Do nothing by default, sub-classes may override this method.Returns the used handshakerMethods inherited from class io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler
bind, close, closeSent, connect, deregister, disconnect, exceptionCaught, flush, read, write
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
-
Field Details
-
handshaker
-
clientConfig
-
-
Constructor Details
-
WebSocketClientProtocolHandler
Base constructor- Parameters:
clientConfig
- Client protocol configuration.
-
WebSocketClientProtocolHandler
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, WebSocketClientProtocolConfig clientConfig) Base constructor- Parameters:
handshaker
- TheWebSocketClientHandshaker
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 serversubprotocol
- Sub protocol request sent to the server.customHeaders
- Map of custom headers to add to the client requestmaxFramePayloadLength
- Maximum length of a frame's payloadhandleCloseFrames
-true
if close frames should not be forwarded and just close the channelperformMasking
- 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 serversubprotocol
- Sub protocol request sent to the server.customHeaders
- Map of custom headers to add to the client requestmaxFramePayloadLength
- Maximum length of a frame's payloadhandleCloseFrames
-true
if close frames should not be forwarded and just close the channelperformMasking
- 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 eventWebSocketClientProtocolHandler.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 serversubprotocol
- Sub protocol request sent to the server.customHeaders
- Map of custom headers to add to the client requestmaxFramePayloadLength
- Maximum length of a frame's payloadhandleCloseFrames
-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 serversubprotocol
- Sub protocol request sent to the server.customHeaders
- Map of custom headers to add to the client requestmaxFramePayloadLength
- Maximum length of a frame's payloadhandleCloseFrames
-true
if close frames should not be forwarded and just close the channelhandshakeTimeoutMillis
- Handshake timeout in mills, when handshake timeout, will trigger user eventWebSocketClientProtocolHandler.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 serversubprotocol
- Sub protocol request sent to the server.customHeaders
- Map of custom headers to add to the client requestmaxFramePayloadLength
- 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 serversubprotocol
- Sub protocol request sent to the server.customHeaders
- Map of custom headers to add to the client requestmaxFramePayloadLength
- Maximum length of a frame's payloadhandshakeTimeoutMillis
- Handshake timeout in mills, when handshake timeout, will trigger user eventWebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT
-
WebSocketClientProtocolHandler
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, boolean handleCloseFrames) Base constructor- Parameters:
handshaker
- TheWebSocketClientHandshaker
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
- TheWebSocketClientHandshaker
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 channelhandshakeTimeoutMillis
- Handshake timeout in mills, when handshake timeout, will trigger user eventWebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT
-
WebSocketClientProtocolHandler
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames) Base constructor- Parameters:
handshaker
- TheWebSocketClientHandshaker
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 channeldropPongFrames
-true
if pong frames should not be forwarded
-
WebSocketClientProtocolHandler
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames, long handshakeTimeoutMillis) Base constructor- Parameters:
handshaker
- TheWebSocketClientHandshaker
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 channeldropPongFrames
-true
if pong frames should not be forwardedhandshakeTimeoutMillis
- Handshake timeout in mills, when handshake timeout, will trigger user eventWebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT
-
WebSocketClientProtocolHandler
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, boolean handleCloseFrames, boolean dropPongFrames, long handshakeTimeoutMillis, boolean withUTF8Validator) Base constructor- Parameters:
handshaker
- TheWebSocketClientHandshaker
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 channeldropPongFrames
-true
if pong frames should not be forwardedhandshakeTimeoutMillis
- Handshake timeout in mills, when handshake timeout, will trigger user eventWebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT
withUTF8Validator
-true
if UTF8 validation of text frames should be enabled
-
WebSocketClientProtocolHandler
Base constructor- Parameters:
handshaker
- TheWebSocketClientHandshaker
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
- TheWebSocketClientHandshaker
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 eventWebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_TIMEOUT
-
-
Method Details
-
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.- Overrides:
decode
in classWebSocketProtocolHandler
- Parameters:
ctx
- theChannelHandlerContext
which thisMessageToMessageDecoder
belongs toframe
- the message to decode to an other oneout
- theList
to which decoded messages should be added- Throws:
Exception
- is thrown if an error occurs
-
buildHandshakeException
Description copied from class:WebSocketProtocolHandler
Returns aWebSocketHandshakeException
that depends on which client or server pipeline this handler belongs. Should be overridden in implementation otherwise a default exception is used.- Overrides:
buildHandshakeException
in classWebSocketProtocolHandler
-
handlerAdded
Description copied from class:ChannelHandlerAdapter
Do nothing by default, sub-classes may override this method.- Specified by:
handlerAdded
in interfaceChannelHandler
- Overrides:
handlerAdded
in classChannelHandlerAdapter
-