reactor.netty.http.server

Interface HttpServerRequest

All Superinterfaces:

HttpInfos, NettyInbound

public interface HttpServerRequest
extends NettyInbound, HttpInfos

An Http Reactive Channel with several accessors related to HTTP flow: headers, params, URI, method, websocket...

Since:

0.5

Method Summary

Modifier and Type	Method and Description
java.net.InetSocketAddress	hostAddress() Returns the address of the host peer or null in case of Unix Domain Sockets.
java.lang.String	param(java.lang.CharSequence key) URI parameter captured via {} "/test/{var}"
java.util.Map<java.lang.String,java.lang.String>	params() Returns the param captured key/value map
HttpServerRequest	paramsResolver(java.util.function.Function<? super java.lang.String,java.util.Map<java.lang.String,java.lang.String>> paramsResolver) Specifies a params resolver.
default reactor.core.publisher.Flux<io.netty.handler.codec.http.HttpContent>	receiveContent() Returns a Flux of HttpContent containing received chunks
java.net.InetSocketAddress	remoteAddress() Returns the address of the remote peer or null in case of Unix Domain Sockets.
io.netty.handler.codec.http.HttpHeaders	requestHeaders() Returns inbound HttpHeaders
java.lang.String	scheme() Returns the current protocol scheme
HttpServerRequest	withConnection(java.util.function.Consumer<? super Connection> withConnection) Calls the passed callback with a Connection to operate on the underlying Channel state.

Methods inherited from interface reactor.netty.NettyInbound

receive, receiveObject

Methods inherited from interface reactor.netty.http.HttpInfos

cookies, fullPath, isKeepAlive, isWebsocket, method, path, uri, version

Method Detail

withConnection

HttpServerRequest withConnection(java.util.function.Consumer<? super Connection> withConnection)

Description copied from interface: NettyInbound

Calls the passed callback with a Connection to operate on the underlying Channel state. This allows for chaining inbound API.

Specified by:

withConnection in interface NettyInbound

Parameters:

withConnection - connection callback

Returns:

the Connection

param

@Nullable
java.lang.String param(java.lang.CharSequence key)

URI parameter captured via {} "/test/{var}"

Parameters:

key - param var name

Returns:

the param captured value

params

@Nullable
java.util.Map<java.lang.String,java.lang.String> params()

Returns the param captured key/value map

Returns:

the param captured key/value map

paramsResolver

HttpServerRequest paramsResolver(java.util.function.Function<? super java.lang.String,java.util.Map<java.lang.String,java.lang.String>> paramsResolver)

Specifies a params resolver.

Parameters:

paramsResolver - a params resolver

Returns:

this HttpServerRequest

receiveContent

default reactor.core.publisher.Flux<io.netty.handler.codec.http.HttpContent> receiveContent()

Returns a Flux of HttpContent containing received chunks

Returns:

a Flux of HttpContent containing received chunks

hostAddress

@Nullable
java.net.InetSocketAddress hostAddress()

Returns the address of the host peer or null in case of Unix Domain Sockets.

Returns:

the host's address

remoteAddress

@Nullable
java.net.InetSocketAddress remoteAddress()

Returns the address of the remote peer or null in case of Unix Domain Sockets.

Returns:

the peer's address

requestHeaders

io.netty.handler.codec.http.HttpHeaders requestHeaders()

Returns inbound HttpHeaders

Returns:

inbound HttpHeaders

scheme

java.lang.String scheme()

Returns the current protocol scheme

Returns:

the protocol scheme