Interface WebSocketFrameEncoder

All Superinterfaces:

ChannelHandler, ChannelOutboundHandler

All Known Implementing Classes:

WebSocket00FrameEncoder, WebSocket07FrameEncoder, WebSocket08FrameEncoder, WebSocket13FrameEncoder

public interface WebSocketFrameEncoder
extends ChannelOutboundHandler

Marker interface which all WebSocketFrame encoders need to implement. This makes it easier to access the added encoder later in the ChannelPipeline.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Method Summary

Methods inherited from interface ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Modifier and Type	Method	Description
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. if you want to handle this event you should implement ChannelInboundHandler and implement the method there.
void	handlerAdded(ChannelHandlerContext ctx)	Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.
void	handlerRemoved(ChannelHandlerContext ctx)	Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Methods inherited from interface ChannelOutboundHandler

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

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a close operation is made.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Called once a connect operation is made.
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	flush(ChannelHandlerContext ctx)	Called once a flush operation is made.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Called once a write operation is made.