io.netty.handler.codec.http.websocketx

类 WebSocketClientProtocolHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

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

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

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 ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) and check if the event was of type WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_ISSUED or WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_COMPLETE.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebSocketClientProtocolHandler.ClientHandshakeStateEvent Events that are fired to notify about handshake status

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
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

方法概要

方法

限定符和类型	方法和说明
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

从类继承的方法 io.netty.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerRemoved

构造器详细资料

WebSocketClientProtocolHandler

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

Base constructor

参数:

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

参数:

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

参数:

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

参数:

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

方法详细资料

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

从类复制的说明: MessageToMessageDecoder

Decode from one message to an other. This method will be called for each written message that can be handled by this encoder.

参数:

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

抛出:

java.lang.Exception - is thrown if an error occurs

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                   java.lang.Throwable cause)
                     throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

exceptionCaught 在接口中 ChannelHandler

指定者:

exceptionCaught 在接口中 ChannelInboundHandler

覆盖:

exceptionCaught 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception