reactor.ipc.netty

Interface NettyInbound

All Known Subinterfaces:

HttpClientResponse, HttpServerRequest, UdpInbound, WebsocketInbound

All Known Implementing Classes:

ChannelOperations, HttpOperations

public interface NettyInbound

An inbound-traffic API delegating to an underlying Channel

Since:

0.6

Author:

Stephane Maldini

Method Summary

Modifier and Type	Method and Description
default <T> Attribute<T>	attr(AttributeKey<T> key) Return a pre-configured attribute stored in every inbound channel
NettyContext	context() Return a NettyContext to operate on the underlying Channel state.
default NettyInbound	context(java.util.function.Consumer<NettyContext> contextCallback) Immediately call the passed callback with a NettyContext to operate on the underlying Channel state.
default NettyInbound	onReadIdle(long idleTimeout, Runnable onReadIdle) Assign a Runnable to be invoked when reads have become idle for the given timeout.
default ByteBufFlux	receive() A Flux extension that allows for extra decoding operators
Flux<?>	receiveObject() a Object inbound Flux
default InetSocketAddress	remoteAddress() Get the address of the remote peer.

Method Detail

attr

default <T> Attribute<T> attr(AttributeKey<T> key)

Return a pre-configured attribute stored in every inbound channel

Type Parameters:

T - a channel attribute type

Parameters:

key - attribute key

Returns:

a Channel attribute

See Also:

AttributeMap.attr(AttributeKey)

context

NettyContext context()

Return a NettyContext to operate on the underlying Channel state.

Returns:

the NettyContext

context

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

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

Parameters:

contextCallback - context callback

Returns:

the NettyContext

onReadIdle

default NettyInbound onReadIdle(long idleTimeout,
                                Runnable onReadIdle)

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

Parameters:

idleTimeout - the idle timeout

onReadIdle - the idle timeout handler

Returns:

this

receive

default ByteBufFlux receive()

A Flux extension that allows for extra decoding operators

Returns:

a new ByteBufFlux

receiveObject

Flux<?> receiveObject()

a Object inbound Flux

Returns:

a Object inbound Flux

remoteAddress

default InetSocketAddress remoteAddress()

Get the address of the remote peer.

Returns:

the peer's address