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, ChannelOutboundHandler

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(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch) Base constructor
WebSocketClientProtocolHandler(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch, long handshakeTimeoutMillis) Base constructor
WebSocketClientProtocolHandler(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, long handshakeTimeoutMillis) Base constructor
WebSocketClientProtocolHandler(java.net.URI webSocketURL, WebSocketVersion version, java.lang.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

方法概要

限定符和类型	方法和说明
void	bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise) Called once a bind operation is made.
protected WebSocketClientHandshakeException	buildHandshakeException(java.lang.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, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise) Called once a connect operation is made.
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame frame, java.util.List<java.lang.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, java.lang.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, java.lang.Object msg, ChannelPromise promise) Called once a write operation is made.

从类继承的方法 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(WebSocketClientProtocolConfig clientConfig)

Base constructor

参数:

clientConfig - Client protocol configuration.

WebSocketClientProtocolHandler

public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
                                      WebSocketClientProtocolConfig clientConfig)

Base constructor

参数:

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(java.net.URI webSocketURL,
                                      WebSocketVersion version,
                                      java.lang.String subprotocol,
                                      boolean allowExtensions,
                                      HttpHeaders customHeaders,
                                      int maxFramePayloadLength,
                                      boolean handleCloseFrames,
                                      boolean performMasking,
                                      boolean allowMaskMismatch)

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

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(java.net.URI webSocketURL,
                                      WebSocketVersion version,
                                      java.lang.String subprotocol,
                                      boolean allowExtensions,
                                      HttpHeaders customHeaders,
                                      int maxFramePayloadLength,
                                      boolean handleCloseFrames,
                                      boolean performMasking,
                                      boolean allowMaskMismatch,
                                      long handshakeTimeoutMillis)

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

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

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

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

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

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

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

参数:

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

参数:

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

参数:

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

参数:

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

参数:

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

参数:

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

参数:

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

方法详细资料

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

参数:

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

buildHandshakeException

protected WebSocketClientHandshakeException buildHandshakeException(java.lang.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)

从类复制的说明: ChannelHandlerAdapter

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

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

close

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

从接口复制的说明: ChannelOutboundHandler

Called once a close operation is made.

指定者:

close 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

write

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

从接口复制的说明: 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

指定者:

write 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

bind

public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a bind operation is made.

指定者:

bind 在接口中 ChannelOutboundHandler

参数:

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

抛出:

java.lang.Exception - thrown if an error occurs

connect

public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a connect operation is made.

指定者:

connect 在接口中 ChannelOutboundHandler

参数:

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

抛出:

java.lang.Exception - thrown if an error occurs

disconnect

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

从接口复制的说明: ChannelOutboundHandler

Called once a disconnect operation is made.

指定者:

disconnect 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

deregister

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

从接口复制的说明: ChannelOutboundHandler

Called once a deregister operation is made from the current registered EventLoop.

指定者:

deregister 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

read

public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Intercepts ChannelHandlerContext.read().

指定者:

read 在接口中 ChannelOutboundHandler

抛出:

java.lang.Exception

flush

public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

指定者:

flush 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the flush operation is made

抛出:

java.lang.Exception - thrown if an error occurs

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