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

Class WebSocketClientExtensionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

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

All Implemented Interfaces:

ChannelHandler

Direct Known Subclasses:

WebSocketClientCompressionHandler

public class WebSocketClientExtensionHandler
extends ChannelHandlerAdapter

This handler negotiates and initializes the WebSocket Extensions. This implementation negotiates the extension with the server in a defined 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.WebSocketClientCompressionHandler.

Nested Class Summary

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

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Constructor and Description
WebSocketClientExtensionHandler(WebSocketClientExtensionHandshaker... extensionHandshakers) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	channelRead(ChannelHandlerContext ctx, Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelHandler in the ChannelPipeline.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, handlerRemoved, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClientExtensionHandler

public WebSocketClientExtensionHandler(WebSocketClientExtensionHandshaker... extensionHandshakers)

Constructor

Parameters:

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

Method Detail

write

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

Description copied from class: ChannelHandlerAdapter

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

Specified by:

write in interface ChannelHandler

Overrides:

write in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

channelRead

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

Description copied from class: ChannelHandlerAdapter

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

Specified by:

channelRead in interface ChannelHandler

Overrides:

channelRead in class ChannelHandlerAdapter

Throws:

Exception