io.netty.handler.codec.http.websocketx.extensions

类 WebSocketServerExtensionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

直接已知子类:

WebSocketServerCompressionHandler

public class WebSocketServerExtensionHandler
extends ChannelDuplexHandler

This handler negotiates and initializes the WebSocket Extensions. It negotiates the extensions based on the client desired order, ensures that the successfully negotiated extensions are consistent between them, and initializes the channel pipeline with the extension decoder and encoder. Find a basic implementation for compression extensions at io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketServerCompressionHandler.

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
WebSocketServerExtensionHandler(WebSocketServerExtensionHandshaker... extensionHandshakers) Constructor

方法概要

限定符和类型	方法和说明
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	onHttpRequestChannelRead(ChannelHandlerContext ctx, HttpRequest request) This is a method exposed to perform fail-fast checks of user-defined http types.
protected void	onHttpResponseWrite(ChannelHandlerContext ctx, HttpResponse response, ChannelPromise promise) This is a method exposed to perform fail-fast checks of user-defined http types.
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

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

bind, close, connect, deregister, disconnect, flush, read

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

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

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

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

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

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

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

exceptionCaught, handlerAdded, handlerRemoved

构造器详细资料

WebSocketServerExtensionHandler

public WebSocketServerExtensionHandler(WebSocketServerExtensionHandshaker... extensionHandshakers)

Constructor

参数:

extensionHandshakers - The extension handshaker in priority order. A handshaker could be repeated many times with fallback configuration.

方法详细资料

channelRead

public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRead 在接口中 ChannelInboundHandler

覆盖:

channelRead 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

onHttpRequestChannelRead

@UnstableApi
protected void onHttpRequestChannelRead(ChannelHandlerContext ctx,
                                                      HttpRequest request)
                                               throws java.lang.Exception

This is a method exposed to perform fail-fast checks of user-defined http types.

eg:
If the user has defined a specific HttpRequest type i.e.CustomHttpRequest and channelRead(io.netty.channel.ChannelHandlerContext, java.lang.Object) can receive LastHttpContent.EMPTY_LAST_CONTENT msg types too, can override it like this:

     public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
         if (msg != LastHttpContent.EMPTY_LAST_CONTENT) {
             if (msg instanceof CustomHttpRequest) {
                 onHttpRequestChannelRead(ctx, (CustomHttpRequest) msg);
             } else {
                 // if it's handling other HttpRequest types it MUST use onHttpRequestChannelRead again
                 // or have to delegate it to super.channelRead (that can perform redundant checks).
                 // If msg is not implementing HttpRequest, it can call ctx.fireChannelRead(msg) on it
                 // ...
                 super.channelRead(ctx, msg);
             }
         } else {
             // given that msg isn't a HttpRequest type we can just skip calling super.channelRead
             ctx.fireChannelRead(msg);
         }
     }
 

IMPORTANT: It already call super.channelRead(ctx, request) before returning.

抛出:

java.lang.Exception

write

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

从类复制的说明: ChannelDuplexHandler

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelDuplexHandler

参数:

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

onHttpResponseWrite

@UnstableApi
protected void onHttpResponseWrite(ChannelHandlerContext ctx,
                                                 HttpResponse response,
                                                 ChannelPromise promise)
                                          throws java.lang.Exception

This is a method exposed to perform fail-fast checks of user-defined http types.

eg:
If the user has defined a specific HttpResponse type i.e.CustomHttpResponse and write(io.netty.channel.ChannelHandlerContext, java.lang.Object, io.netty.channel.ChannelPromise) can receive ByteBuf msg types too, it can be overridden like this:

     public void write(final ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
         if (msg != Unpooled.EMPTY_BUFFER && !(msg instanceof ByteBuf)) {
             if (msg instanceof CustomHttpResponse) {
                 onHttpResponseWrite(ctx, (CustomHttpResponse) msg, promise);
             } else {
                 // if it's handling other HttpResponse types it MUST use onHttpResponseWrite again
                 // or have to delegate it to super.write (that can perform redundant checks).
                 // If msg is not implementing HttpResponse, it can call ctx.write(msg, promise) on it
                 // ...
                 super.write(ctx, msg, promise);
             }
         } else {
             // given that msg isn't a HttpResponse type we can just skip calling super.write
             ctx.write(msg, promise);
         }
     }
 

IMPORTANT: It already call super.write(ctx, response, promise) before returning.

抛出:

java.lang.Exception