Netty 5.0.0.Alpha5 · io.netty5.handler.codec.http.HttpServerKeepAliveHandler

HttpServerKeepAliveHandler helps close persistent connections when appropriate.

The server channel is expected to set the proper 'Connection' header if it can handle persistent connections. HttpServerKeepAliveHandler will automatically close the channel for any LastHttpContent that corresponds to a client request for closing the connection, or if the HttpResponse associated with that LastHttpContent requested closing the connection or didn't have a self defined message length.

Since HttpServerKeepAliveHandler expects HttpObjects it should be added after HttpServerCodec but before any other handlers that might send a HttpResponse.

 ChannelPipeline p = ...;
 ...
 p.addLast("serverCodec", new HttpServerCodec());
 p.addLast("httpKeepAlive", new HttpServerKeepAliveHandler());
 p.addLast("aggregator", new HttpObjectAggregator(1048576));
 ...
 p.addLast("handler", new HttpRequestHandler());

Field Summary

Modifier and Type	Field and Description
private static final String	MULTIPART_PREFIX
private int	pendingResponses
private boolean	persistentConnection

Constructor Summary

Access	Constructor and Description
public	HttpServerKeepAliveHandler()

Method Summary

Modifier and Type	Method and Description
public void	channelRead(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.channelRead. Invoked when the current `Channel` has read a message from the peer.
private static boolean	isInformational(HttpResponse response)
private static boolean	isMultipart(HttpResponse response)
private static boolean	Returns: true if the response has a self defined message length. isSelfDefinedMessageLength(HttpResponse The HttpResponse to check response) Keep-alive only works if the client can detect when the message has ended without relying on the connection being closed.
private boolean	shouldKeepAlive()
private void	trackResponse(HttpResponse response)
public Future<Void>	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg) Overrides default io.netty5.channel.ChannelHandler.write. Called once a write operation is made.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

MULTIPART_PREFIX	back to summary
private static final String MULTIPART_PREFIX

pendingResponses	back to summary
private int pendingResponses

persistentConnection	back to summary
private boolean persistentConnection

Constructor Detail

HttpServerKeepAliveHandler	back to summary
public HttpServerKeepAliveHandler()

Method Detail

channelRead back to summary

channelRead	back to summary
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelRead. Doc from io.netty5.channel.ChannelHandler.channelRead. Invoked when the current `Channel` has read a message from the peer. Annotations @Override

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

Overrides default io.netty5.channel.ChannelHandler.channelRead.

Doc from io.netty5.channel.ChannelHandler.channelRead.

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

Annotations

@Override

isInformational	back to summary
private static boolean isInformational(HttpResponse response)

isMultipart	back to summary
private static boolean isMultipart(HttpResponse response)

isSelfDefinedMessageLength	back to summary
private static boolean isSelfDefinedMessageLength(HttpResponse response) Keep-alive only works if the client can detect when the message has ended without relying on the connection being closed. See See See Parameters response:HttpResponse The HttpResponse to check Returns:boolean true if the response has a self defined message length.

isSelfDefinedMessageLength

back to summary

private static boolean isSelfDefinedMessageLength(HttpResponse response)

Keep-alive only works if the client can detect when the message has ended without relying on the connection being closed.

Parameters

shouldKeepAlive	back to summary
private boolean shouldKeepAlive()

trackResponse	back to summary
private void trackResponse(HttpResponse response)

write back to summary

write	back to summary
public Future<Void> write(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.write. Doc from io.netty5.channel.ChannelHandler.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 Returns:Future<Void> the `Future` which will be notified once the operation completes. Annotations @Override

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

Overrides default io.netty5.channel.ChannelHandler.write.

Doc from io.netty5.channel.ChannelHandler.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

Returns:Future<Void>

the Future which will be notified once the operation completes.