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:

ChannelHandler

Direct Known Subclasses:

WebSocketServerCompressionHandler

public class WebSocketServerExtensionHandler
extends Object
implements 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(ChannelHandlerContext ctx, Object msg)	Invoked when the current Channel has read a message from the peer.
Future<Void>	write(ChannelHandlerContext ctx, Object msg)	Called once a write operation is made.

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(ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Description copied from interface: ChannelHandler

Invoked when the current Channel has read a message from the peer.

Specified by:

channelRead in interface ChannelHandler

Throws:

Exception

write

public Future<Void> write(ChannelHandlerContext ctx,
                          Object msg)

Description copied from interface: ChannelHandler

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.

Specified by:

write in interface ChannelHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

Returns:

the Future which will be notified once the operation completes.