reactor.netty.http.server

Interface HttpServerRequest

All Superinterfaces:

HttpInfos, NettyInbound

All Known Implementing Classes:

HttpToH2Operations

public interface HttpServerRequest
extends NettyInbound, HttpInfos

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

Since:

0.5

Author:

Stephane Maldini

Method Summary

Modifier and Type	Method and Description
java.net.InetSocketAddress	hostAddress() Return the address of the host peer.
java.lang.String	param(java.lang.CharSequence key) URI parameter captured via {} "/test/{var}"
java.util.Map<java.lang.String,java.lang.String>	params() Return 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>> headerResolver)
default reactor.core.publisher.Flux<io.netty.handler.codec.http.HttpContent>	receiveContent() Return a Flux of HttpContent containing received chunks
java.net.InetSocketAddress	remoteAddress() Return the address of the remote peer.
io.netty.handler.codec.http.HttpHeaders	requestHeaders() Return inbound HttpHeaders
java.lang.String	scheme() Return the current scheme
HttpServerRequest	withConnection(java.util.function.Consumer<? super Connection> withConnection) Call 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, isKeepAlive, isWebsocket, method, path, uri, version

Method Detail

withConnection

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

Description copied from interface: NettyInbound

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

Return 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>> headerResolver)

Parameters:

headerResolver - provide a params

Returns:

this request

receiveContent

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

Return a Flux of HttpContent containing received chunks

Returns:

a Flux of HttpContent containing received chunks

hostAddress

java.net.InetSocketAddress hostAddress()

Return the address of the host peer.

Returns:

the host's address

remoteAddress

java.net.InetSocketAddress remoteAddress()

Return the address of the remote peer.

Returns:

the peer's address

requestHeaders

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

Return inbound HttpHeaders

Returns:

inbound HttpHeaders

scheme

java.lang.String scheme()

Return the current scheme

Returns:

the protocol scheme