Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx.extensions

Class WebSocketServerExtensionHandler

java.lang.Object

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

All Implemented Interfaces:

io.netty5.channel.ChannelHandler

Direct Known Subclasses:

WebSocketServerCompressionHandler

public class WebSocketServerExtensionHandler
extends Object
implements io.netty5.channel.ChannelHandler

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.netty5.handler.codec.http.websocketx.extensions.compression.WebSocketServerCompressionHandler.

Constructor Summary

Constructors

Constructor	Description
WebSocketServerExtensionHandler(WebSocketServerExtensionHandshaker... extensionHandshakers)	Constructor

Method Summary

Modifier and Type	Method	Description
void	channelRead(io.netty5.channel.ChannelHandlerContext ctx, Object msg)
io.netty5.util.concurrent.Future<Void>	write(io.netty5.channel.ChannelHandlerContext ctx, Object msg)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelExceptionCaught, channelInactive, channelInboundEvent, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown

Constructor Detail

WebSocketServerExtensionHandler

public WebSocketServerExtensionHandler(WebSocketServerExtensionHandshaker... extensionHandshakers)

Constructor

Parameters:

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

Method Detail

channelRead

public void channelRead(io.netty5.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty5.channel.ChannelHandler

Throws:

Exception

write

public io.netty5.util.concurrent.Future<Void> write(io.netty5.channel.ChannelHandlerContext ctx,
                                                    Object msg)

Specified by:

write in interface io.netty5.channel.ChannelHandler