reactor.io.net

Interface ReactorChannel<IN,OUT>

All Superinterfaces:

org.reactivestreams.Publisher<IN>

All Known Implementing Classes:

ChannelStream, HttpChannel, NettyChannelStream, NettyHttpChannel, ZeroMQChannelStream

public interface ReactorChannel<IN,OUT>
extends org.reactivestreams.Publisher<IN>

Channel is a virtual connection that often matches with a Socket or a Channel (e.g. Netty). Implementations handle interacting inbound (received data) and errors by subscribing to it. Writing and "flushing" is controlled by sinking 1 or more writeWith(Publisher) that will forward data to outbound. When a drained Publisher completes or error, the channel will automatically "flush" its pending writes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ReactorChannel.ConsumerSpec Spec class for assigning multiple event handlers on a channel.

Method Summary

Modifier and Type	Method and Description
ReactorChannel.ConsumerSpec	on() Assign event handlers to certain channel lifecycle events.
java.net.InetSocketAddress	remoteAddress() Get the address of the remote peer.
org.reactivestreams.Publisher<java.lang.Void>	writeWith(org.reactivestreams.Publisher<? extends OUT> dataStream) Send data to the peer, listen for any error on write and close on terminal signal (complete|error).

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

remoteAddress

java.net.InetSocketAddress remoteAddress()

Get the address of the remote peer.

Returns:

the peer's address

writeWith

org.reactivestreams.Publisher<java.lang.Void> writeWith(org.reactivestreams.Publisher<? extends OUT> dataStream)

Send data to the peer, listen for any error on write and close on terminal signal (complete|error). If more than one publisher is attached (multiple calls to writeWith()) completion occurs after all publishers complete.

Parameters:

dataStream - the dataStream publishing OUT items to write on this channel

Returns:

A Publisher to signal successful sequence write (e.g. after "flush") or any error during write

on

ReactorChannel.ConsumerSpec on()

Assign event handlers to certain channel lifecycle events.

Returns:

ConsumerSpec to build the events handlers