io.netty.handler.codec.http.websocketx

Class WebSocketClientProtocolHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<WebSocketFrame>

io.netty.handler.codec.http.websocketx.WebSocketClientProtocolHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleInboundMessageHandler<WebSocketFrame>, io.netty.channel.ChannelInboundMessageHandler<WebSocketFrame>, io.netty.channel.ChannelStateHandler

public class WebSocketClientProtocolHandler
extends io.netty.channel.ChannelInboundMessageHandlerAdapter<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.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

ABORT

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(WebSocketClientHandshaker handshaker) Base constructor
WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, boolean handleCloseFrames) Base constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	afterAdd(io.netty.channel.ChannelHandlerContext ctx)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
void	messageReceived(io.netty.channel.ChannelHandlerContext ctx, WebSocketFrame frame)

Methods inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

acceptInboundMessage, beginMessageReceived, endMessageReceived, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterRemove, beforeAdd, beforeRemove

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

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

afterRemove, beforeAdd, beforeRemove

Constructor Detail

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)

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

messageReceived

public void messageReceived(io.netty.channel.ChannelHandlerContext ctx,
                   WebSocketFrame frame)
                     throws Exception

Specified by:

messageReceived in interface io.netty.channel.ChannelHandlerUtil.SingleInboundMessageHandler<WebSocketFrame>

Throws:

Exception

afterAdd

public void afterAdd(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

afterAdd in interface io.netty.channel.ChannelHandler

Overrides:

afterAdd in class io.netty.channel.ChannelHandlerAdapter

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception