Netty/Codec/HTTP 4.1.107.Final · io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler

Modifier and Type	Field and Description
private ChannelPromise	closeSent
private final WebSocketCloseStatus	closeStatus
private final boolean	dropPongFrames
private final long	forceCloseTimeoutMillis

Access	Constructor and Description
pack-priv	WebSocketProtocolHandler() Creates a new `WebSocketProtocolHandler` that will drop `PongWebSocketFrame`s.
pack-priv	WebSocketProtocolHandler(boolean `true` if `PongWebSocketFrame`s should be dropped dropPongFrames) Creates a new `WebSocketProtocolHandler`, given a parameter that determines whether or not to drop `PongWebSocketFrame`s.
pack-priv	WebSocketProtocolHandler(boolean dropPongFrames, WebSocketCloseStatus closeStatus, long forceCloseTimeoutMillis)

Method Summary

Modifier and Type	Method and Description
private void	applyCloseSentTimeout(ChannelHandlerContext ctx)
public void	bind(ChannelHandlerContext the `ChannelHandlerContext` for which the bind operation is made ctx, SocketAddress the `SocketAddress` to which it should bound localAddress, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.bind. Called once a bind operation is made.
protected WebSocketHandshakeException	buildHandshakeException(String message) Returns a `WebSocketHandshakeException` that depends on which client or server pipeline this handler belongs.
public void	close(final ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, final ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.close. Called once a close operation is made.
pack-priv void	closeSent(ChannelPromise promise)
public void	connect(ChannelHandlerContext the `ChannelHandlerContext` for which the connect operation is made ctx, SocketAddress the `SocketAddress` to which it should connect remoteAddress, SocketAddress the `SocketAddress` which is used as source on connect localAddress, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.connect. Called once a connect operation is made.
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, WebSocketFrame the message to decode to an other one frame, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other.
public void	deregister(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.deregister. Called once a deregister operation is made from the current registered `EventLoop`.
public void	disconnect(ChannelHandlerContext the `ChannelHandlerContext` for which the disconnect operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.disconnect. Called once a disconnect operation is made.
public void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Gets called if a `Throwable` was thrown.
public void	flush(ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made ctx) Implements io.netty.channel.ChannelOutboundHandler.flush. Called once a flush operation is made.
public void	read(ChannelHandlerContext ctx) Implements io.netty.channel.ChannelOutboundHandler.read. Intercepts `ChannelHandlerContext#read()`.
private static void	readIfNeeded(ChannelHandlerContext ctx)
public void	write(final ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.write. Called once a write operation is made.

Inherited from io.netty.handler.codec.MessageToMessageDecoder:: acceptInboundMessage channelRead

closeSent	back to summary
private ChannelPromise closeSent

closeStatus	back to summary
private final WebSocketCloseStatus closeStatus

dropPongFrames	back to summary
private final boolean dropPongFrames

forceCloseTimeoutMillis	back to summary
private final long forceCloseTimeoutMillis

WebSocketProtocolHandler	back to summary
pack-priv WebSocketProtocolHandler() Creates a new `WebSocketProtocolHandler` that will drop `PongWebSocketFrame`s.

WebSocketProtocolHandler	back to summary
pack-priv WebSocketProtocolHandler(boolean dropPongFrames) Creates a new `WebSocketProtocolHandler`, given a parameter that determines whether or not to drop `PongWebSocketFrame`s. Parameters dropPongFrames:boolean `true` if `PongWebSocketFrame`s should be dropped

WebSocketProtocolHandler	back to summary
pack-priv WebSocketProtocolHandler(boolean dropPongFrames, WebSocketCloseStatus closeStatus, long forceCloseTimeoutMillis)

Method Detail

applyCloseSentTimeout	back to summary
private void applyCloseSentTimeout(ChannelHandlerContext ctx)

bind back to summary

bind	back to summary
public void bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) throws Exception Implements io.netty.channel.ChannelOutboundHandler.bind. Doc from io.netty.channel.ChannelOutboundHandler.bind. Called once a bind operation is made. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the bind operation is made localAddress:SocketAddress the `SocketAddress` to which it should bound promise:ChannelPromise the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: thrown if an error occurs

public void bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.bind.

Doc from io.netty.channel.ChannelOutboundHandler.bind.

Called once a bind operation is made.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the bind operation is made
localAddress:SocketAddress: the SocketAddress to which it should bound
promise:ChannelPromise: the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

buildHandshakeException	back to summary
protected WebSocketHandshakeException buildHandshakeException(String message) Returns a `WebSocketHandshakeException` that depends on which client or server pipeline this handler belongs. Should be overridden in implementation otherwise a default exception is used.

close back to summary

close	back to summary
public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception Implements io.netty.channel.ChannelOutboundHandler.close. Doc from io.netty.channel.ChannelOutboundHandler.close. Called once a close operation is made. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made promise:ChannelPromise the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: thrown if an error occurs

public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.close.

Doc from io.netty.channel.ChannelOutboundHandler.close.

Called once a close operation is made.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the close operation is made
promise:ChannelPromise: the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

closeSent	back to summary
pack-priv void closeSent(ChannelPromise promise)

connect back to summary

connect	back to summary
public void connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) throws Exception Implements io.netty.channel.ChannelOutboundHandler.connect. Doc from io.netty.channel.ChannelOutboundHandler.connect. Called once a connect operation is made. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the connect operation is made remoteAddress:SocketAddress the `SocketAddress` to which it should connect localAddress:SocketAddress the `SocketAddress` which is used as source on connect promise:ChannelPromise the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: thrown if an error occurs

public void connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.connect.

Doc from io.netty.channel.ChannelOutboundHandler.connect.

Called once a connect operation is made.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the connect operation is made
remoteAddress:SocketAddress: the SocketAddress to which it should connect
localAddress:SocketAddress: the SocketAddress which is used as source on connect
promise:ChannelPromise: the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Doc from io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other. This method will be called for each written message that can be handled by this decoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to frame:WebSocketFrame the message to decode to an other one out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode.

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
frame:WebSocketFrame: the message to decode to an other one
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

deregister back to summary

deregister	back to summary
public void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception Implements io.netty.channel.ChannelOutboundHandler.deregister. Doc from io.netty.channel.ChannelOutboundHandler.deregister. Called once a deregister operation is made from the current registered `EventLoop`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made promise:ChannelPromise the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: thrown if an error occurs

public void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.deregister.

Doc from io.netty.channel.ChannelOutboundHandler.deregister.

Called once a deregister operation is made from the current registered EventLoop.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the close operation is made
promise:ChannelPromise: the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

disconnect back to summary

disconnect	back to summary
public void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception Implements io.netty.channel.ChannelOutboundHandler.disconnect. Doc from io.netty.channel.ChannelOutboundHandler.disconnect. Called once a disconnect operation is made. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the disconnect operation is made promise:ChannelPromise the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: thrown if an error occurs

public void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.disconnect.

Doc from io.netty.channel.ChannelOutboundHandler.disconnect.

Called once a disconnect operation is made.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the disconnect operation is made
promise:ChannelPromise: the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

exceptionCaught back to summary

exceptionCaught	back to summary
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Doc from io.netty.channel.ChannelHandler.exceptionCaught. Gets called if a `Throwable` was thrown. Annotations @Override

public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught.

Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught.

Doc from io.netty.channel.ChannelHandler.exceptionCaught.

Gets called if a Throwable was thrown.

Annotations

@Override

flush back to summary

flush	back to summary
public void flush(ChannelHandlerContext ctx) throws Exception Implements io.netty.channel.ChannelOutboundHandler.flush. Doc from io.netty.channel.ChannelOutboundHandler.flush. Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made Annotations @Override Exceptions Exception: thrown if an error occurs

public void flush(ChannelHandlerContext ctx) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.flush.

Doc from io.netty.channel.ChannelOutboundHandler.flush.

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the flush operation is made

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

read back to summary

read	back to summary
public void read(ChannelHandlerContext ctx) throws Exception Implements io.netty.channel.ChannelOutboundHandler.read. Doc from io.netty.channel.ChannelOutboundHandler.read. Intercepts `ChannelHandlerContext#read()`. Annotations @Override

public void read(ChannelHandlerContext ctx) throws Exception

Implements io.netty.channel.ChannelOutboundHandler.read.

Doc from io.netty.channel.ChannelOutboundHandler.read.

Intercepts ChannelHandlerContext#read().

Annotations

@Override

readIfNeeded	back to summary
private static void readIfNeeded(ChannelHandlerContext ctx)

write back to summary

write	back to summary
public void write(final ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception Implements io.netty.channel.ChannelOutboundHandler.write. Doc from io.netty.channel.ChannelOutboundHandler.write. 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 Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made msg:Object the message to write promise:ChannelPromise the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: thrown if an error occurs

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

Implements io.netty.channel.ChannelOutboundHandler.write.

Doc from io.netty.channel.ChannelOutboundHandler.write.

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

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the write operation is made
msg:Object: the message to write
promise:ChannelPromise: the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:: thrown if an error occurs

pack-priv abstract Class WebSocketProtocolHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail