HTTP functionality for the Reactor Netty library 1.1.16 · reactor.netty.http.server.HttpTrafficHandler

Modifier and Type	Class and Description
pack-priv static class	HttpTrafficHandler.HttpRequestHolder

Modifier and Type

Class and Description

pack-priv static class

HttpTrafficHandler.HttpRequestHolder

Modifier and Type	Field and Description
pack-priv final BiPredicate<HttpServerRequest, HttpServerResponse>	compress
pack-priv final ServerCookieDecoder	cookieDecoder
pack-priv final ServerCookieEncoder	cookieEncoder
pack-priv ChannelHandlerContext	ctx
pack-priv final HttpServerFormDecoderProvider	formDecoderProvider
pack-priv final BiFunction<ConnectionInfo, HttpRequest, ConnectionInfo>	forwardedHeaderHandler
pack-priv static final HttpVersion	H2
pack-priv final HttpMessageLogFactory	httpMessageLogFactory
pack-priv final Duration	idleTimeout
pack-priv final ConnectionObserver	listener
pack-priv final BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>>	mapHandle
pack-priv final int	maxKeepAliveRequests
pack-priv static final String	MULTIPART_PREFIX
pack-priv boolean	nonInformationalResponse
pack-priv boolean	overflow
pack-priv int	pendingResponses
pack-priv boolean	persistentConnection
pack-priv Queue<Object>	pipelined
pack-priv final Duration	readTimeout
pack-priv SocketAddress	remoteAddress
pack-priv final Duration	requestTimeout
pack-priv Boolean	secure

Modifier and Type

Field and Description

pack-priv final BiPredicate<HttpServerRequest, HttpServerResponse>

compress

pack-priv final ServerCookieDecoder

cookieDecoder

pack-priv final ServerCookieEncoder

cookieEncoder

pack-priv ChannelHandlerContext

ctx

pack-priv final HttpServerFormDecoderProvider

formDecoderProvider

pack-priv final BiFunction<ConnectionInfo, HttpRequest, ConnectionInfo>

forwardedHeaderHandler

pack-priv static final HttpVersion

pack-priv final HttpMessageLogFactory

httpMessageLogFactory

pack-priv final Duration

idleTimeout

pack-priv final ConnectionObserver

listener

pack-priv final BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>>

mapHandle

pack-priv final int

maxKeepAliveRequests

pack-priv static final String

MULTIPART_PREFIX

pack-priv boolean

nonInformationalResponse

pack-priv boolean

overflow

pack-priv int

pendingResponses

pack-priv boolean

persistentConnection

pack-priv Queue<Object>

pipelined

pack-priv final Duration

readTimeout

pack-priv SocketAddress

remoteAddress

pack-priv final Duration

requestTimeout

pack-priv Boolean

secure

Access	Constructor and Description
pack-priv	HttpTrafficHandler(BiPredicate<HttpServerRequest, HttpServerResponse> compress, ServerCookieDecoder decoder, ServerCookieEncoder encoder, HttpServerFormDecoderProvider formDecoderProvider, BiFunction<ConnectionInfo, HttpRequest, ConnectionInfo> forwardedHeaderHandler, HttpMessageLogFactory httpMessageLogFactory, Duration idleTimeout, ConnectionObserver listener, BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>> mapHandle, int maxKeepAliveRequests, Duration readTimeout, Duration requestTimeout)

Access

Constructor and Description

Modifier and Type	Method and Description
public void	channelActive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Implements io.netty.channel.ChannelInboundHandler.channelActive. Calls `ChannelHandlerContext#fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelRead(ChannelHandlerContext ctx, Object msg) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
pack-priv final void	discard()
pack-priv void	doPipeline(ChannelHandlerContext ctx, Object msg)
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
pack-priv static boolean	isInformational(HttpResponse response)
pack-priv static boolean	isMultipart(HttpResponse response)
pack-priv static boolean	isNoContent(HttpResponse response)
pack-priv static boolean	isNotModified(HttpResponse response)
pack-priv 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.
public void	operationComplete(ChannelFuture the source `Future` which called this callback future) Implements io.netty.util.concurrent.GenericFutureListener.operationComplete. Invoked when the operation associated with the `Future` has been completed.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
pack-priv void	sendDecodingFailures(Throwable t, Object msg)
pack-priv void	sendDecodingFailures(Throwable t, Object msg, ZonedDateTime timestamp, ConnectionInfo connectionInfo)
pack-priv boolean	shouldKeepAlive()
public void	write(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) Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.

Modifier and Type

Method and Description

public void

channelActive(ChannelHandlerContext ctx)

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive.

Implements io.netty.channel.ChannelInboundHandler.channelActive.

Calls ChannelHandlerContext#fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.

public void

channelRead(ChannelHandlerContext ctx, Object msg)

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

Implements io.netty.channel.ChannelInboundHandler.channelRead.

Calls ChannelHandlerContext#fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

pack-priv final void

discard()

pack-priv void

doPipeline(ChannelHandlerContext ctx, Object msg)

public void

handlerAdded(ChannelHandlerContext ctx)

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

public void

handlerRemoved(ChannelHandlerContext ctx)

Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved.

Implements io.netty.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

pack-priv static boolean

isInformational(HttpResponse response)

pack-priv static boolean

isMultipart(HttpResponse response)

pack-priv static boolean

isNoContent(HttpResponse response)

pack-priv static boolean

isNotModified(HttpResponse response)

pack-priv 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.

public void

operationComplete(ChannelFuture

the source Future which called this callback

future)

Implements io.netty.util.concurrent.GenericFutureListener.operationComplete.

Invoked when the operation associated with the Future has been completed.

public void

run()

Implements java.lang.Runnable.run.

Runs this operation.

pack-priv void

sendDecodingFailures(Throwable t, Object msg)

pack-priv void

sendDecodingFailures(Throwable t, Object msg, ZonedDateTime timestamp, ConnectionInfo connectionInfo)

pack-priv boolean

shouldKeepAlive()

public void

write(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)

Overrides io.netty.channel.ChannelDuplexHandler.write.

Implements io.netty.channel.ChannelOutboundHandler.write.

Calls ChannelHandlerContext#write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Field Detail

compress	back to summary
pack-priv final BiPredicate<HttpServerRequest, HttpServerResponse> compress

cookieDecoder	back to summary
pack-priv final ServerCookieDecoder cookieDecoder

cookieEncoder	back to summary
pack-priv final ServerCookieEncoder cookieEncoder

ctx	back to summary
pack-priv ChannelHandlerContext ctx

formDecoderProvider	back to summary
pack-priv final HttpServerFormDecoderProvider formDecoderProvider

forwardedHeaderHandler	back to summary
pack-priv final BiFunction<ConnectionInfo, HttpRequest, ConnectionInfo> forwardedHeaderHandler

H2	back to summary
pack-priv static final HttpVersion H2

httpMessageLogFactory	back to summary
pack-priv final HttpMessageLogFactory httpMessageLogFactory

idleTimeout	back to summary
pack-priv final Duration idleTimeout

listener	back to summary
pack-priv final ConnectionObserver listener

mapHandle	back to summary
pack-priv final BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>> mapHandle

maxKeepAliveRequests	back to summary
pack-priv final int maxKeepAliveRequests

MULTIPART_PREFIX	back to summary
pack-priv static final String MULTIPART_PREFIX

nonInformationalResponse	back to summary
pack-priv boolean nonInformationalResponse

overflow	back to summary
pack-priv boolean overflow

pendingResponses	back to summary
pack-priv int pendingResponses

persistentConnection	back to summary
pack-priv boolean persistentConnection

pipelined	back to summary
pack-priv Queue<Object> pipelined

readTimeout	back to summary
pack-priv final Duration readTimeout

remoteAddress	back to summary
pack-priv SocketAddress remoteAddress

requestTimeout	back to summary
pack-priv final Duration requestTimeout

secure	back to summary
pack-priv Boolean secure

HttpTrafficHandler

back to summary

pack-priv HttpTrafficHandler(BiPredicate<HttpServerRequest, HttpServerResponse> compress, ServerCookieDecoder decoder, ServerCookieEncoder encoder, HttpServerFormDecoderProvider formDecoderProvider, BiFunction<ConnectionInfo, HttpRequest, ConnectionInfo> forwardedHeaderHandler, HttpMessageLogFactory httpMessageLogFactory, Duration idleTimeout, ConnectionObserver listener, BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>> mapHandle, int maxKeepAliveRequests, Duration readTimeout, Duration requestTimeout)

Method Detail

channelActive back to summary

channelActive	back to summary
public void channelActive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Implements io.netty.channel.ChannelInboundHandler.channelActive. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Calls `ChannelHandlerContext#fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelActive(ChannelHandlerContext ctx)

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive.

Implements io.netty.channel.ChannelInboundHandler.channelActive.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelActive.

Calls ChannelHandlerContext#fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

channelRead back to summary

channelRead	back to summary
public void channelRead(ChannelHandlerContext ctx, Object msg) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelRead(ChannelHandlerContext ctx, Object msg)

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

Implements io.netty.channel.ChannelInboundHandler.channelRead.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

Calls ChannelHandlerContext#fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

discard	back to summary
pack-priv final void discard()

doPipeline	back to summary
pack-priv void doPipeline(ChannelHandlerContext ctx, Object msg)

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Doc from io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Doc from io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx)

Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved.

Implements io.netty.channel.ChannelHandler.handlerRemoved.

Doc from io.netty.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

isInformational	back to summary
pack-priv static boolean isInformational(HttpResponse response)

isMultipart	back to summary
pack-priv static boolean isMultipart(HttpResponse response)

isNoContent	back to summary
pack-priv static boolean isNoContent(HttpResponse response)

isNotModified	back to summary
pack-priv static boolean isNotModified(HttpResponse response)

isSelfDefinedMessageLength	back to summary
pack-priv 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 Parameters response:HttpResponse The HttpResponse to check Returns:boolean true if the response has a self defined message length.

isSelfDefinedMessageLength

back to summary

pack-priv 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

operationComplete back to summary

operationComplete	back to summary
public void operationComplete(ChannelFuture future) Implements io.netty.util.concurrent.GenericFutureListener.operationComplete. Doc from io.netty.util.concurrent.GenericFutureListener.operationComplete. Invoked when the operation associated with the `Future` has been completed. Parameters future:ChannelFuture the source `Future` which called this callback Annotations @Override

public void operationComplete(ChannelFuture future)

Implements io.netty.util.concurrent.GenericFutureListener.operationComplete.

Doc from io.netty.util.concurrent.GenericFutureListener.operationComplete.

Invoked when the operation associated with the Future has been completed.

Parameters

future:ChannelFuture: the source Future which called this callback

Annotations

@Override

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

sendDecodingFailures	back to summary
pack-priv void sendDecodingFailures(Throwable t, Object msg)

sendDecodingFailures	back to summary
pack-priv void sendDecodingFailures(Throwable t, Object msg, ZonedDateTime timestamp, ConnectionInfo connectionInfo)

shouldKeepAlive	back to summary
pack-priv boolean shouldKeepAlive()

write back to summary

write	back to summary
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Doc from io.netty.channel.ChannelDuplexHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Parameters ctx:ChannelHandlerContext Doc from io.netty.channel.ChannelOutboundHandler.write. the `ChannelHandlerContext` for which the write operation is made msg:Object Doc from io.netty.channel.ChannelOutboundHandler.write. the message to write promise:ChannelPromise Doc from io.netty.channel.ChannelOutboundHandler.write. the `ChannelPromise` to notify once the operation completes Annotations @Override @SuppressWarnings:FutureReturnValueIgnored

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

Overrides io.netty.channel.ChannelDuplexHandler.write.

Implements io.netty.channel.ChannelOutboundHandler.write.

Doc from io.netty.channel.ChannelDuplexHandler.write.

Calls ChannelHandlerContext#write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Parameters

ctx:ChannelHandlerContext

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

the ChannelHandlerContext for which the write operation is made

msg:Object

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

the message to write

promise:ChannelPromise

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

the ChannelPromise to notify once the operation completes

Annotations

@Override
@SuppressWarnings:FutureReturnValueIgnored

pack-priv final Class HttpTrafficHandler.HttpRequestHolder

extends Object

Class Inheritance

java.lang.Object
reactor.netty.http.server.HttpTrafficHandler.HttpRequestHolder

Field Summary

Modifier and Type	Field and Description
pack-priv final HttpRequest	request
pack-priv final ZonedDateTime	timestamp

Constructor Summary

Access	Constructor and Description
pack-priv	HttpRequestHolder(HttpRequest request)

Field Detail

request	back to summary
pack-priv final HttpRequest request

timestamp	back to summary
pack-priv final ZonedDateTime timestamp

Constructor Detail

HttpRequestHolder	back to summary
pack-priv HttpRequestHolder(HttpRequest request)

pack-priv final Class HttpTrafficHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class HttpTrafficHandler.HttpRequestHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail