reactor.ipc.netty.http.server

Interface HttpServerRequest

All Superinterfaces:

HttpInfos, NettyInbound

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
default HttpServerRequest	context(java.util.function.Consumer<NettyContext> contextCallback) Immediately call the passed callback with a NettyContext to operate on the underlying Channel state.
default HttpServerRequest	onReadIdle(long idleTimeout, java.lang.Runnable onReadIdle) Assign a Runnable to be invoked when reads have become idle for the given timeout.
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 Flux<HttpContent>	receiveContent() Return a Flux of HttpContent containing received chunks
HttpHeaders	requestHeaders() Return inbound HttpHeaders

Methods inherited from interface reactor.ipc.netty.NettyInbound

attr, context, receive, receiveObject, remoteAddress

Methods inherited from interface reactor.ipc.netty.http.HttpInfos

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

Method Detail

onReadIdle

default HttpServerRequest onReadIdle(long idleTimeout,
                                     java.lang.Runnable onReadIdle)

Description copied from interface: NettyInbound

Assign a Runnable to be invoked when reads have become idle for the given timeout. This replaces any previously set idle callback.

Specified by:

onReadIdle in interface NettyInbound

Parameters:

idleTimeout - the idle timeout

onReadIdle - the idle timeout handler

Returns:

this

context

default HttpServerRequest context(java.util.function.Consumer<NettyContext> contextCallback)

Description copied from interface: NettyInbound

Immediately call the passed callback with a NettyContext to operate on the underlying Channel state. This allows for chaining inbound API.

Specified by:

context in interface NettyInbound

Parameters:

contextCallback - context callback

Returns:

the NettyContext

param

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

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 Flux<HttpContent> receiveContent()

Return a Flux of HttpContent containing received chunks

Returns:

a Flux of HttpContent containing received chunks

requestHeaders

HttpHeaders requestHeaders()

Return inbound HttpHeaders

Returns:

inbound HttpHeaders