reactor.ipc.netty.tcp

Class TcpClient

java.lang.Object

reactor.ipc.netty.tcp.TcpClient

All Implemented Interfaces:

NettyConnector<NettyInbound,NettyOutbound>

public class TcpClient
extends java.lang.Object
implements NettyConnector<NettyInbound,NettyOutbound>

A TCP client connector.

Author:

Stephane Maldini, Violeta Georgieva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpClient.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected static ChannelOperations.OnNew	EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TcpClient(ClientOptions options)
protected	TcpClient(TcpClient.Builder builder)

Method Summary

Modifier and Type	Method and Description
static TcpClient.Builder	builder() Creates a builder for TcpClient
static TcpClient	create() Bind a new TCP client to the localhost on port 12012.
static TcpClient	create(java.util.function.Consumer<? super ClientOptions.Builder<?>> options) Bind a new TCP client to the specified connect address and port.
static TcpClient	create(int port) Bind a new TCP client to "localhost" on the the specified port.
static TcpClient	create(java.lang.String bindAddress) Bind a new TCP client to the specified connect address and port 12012.
static TcpClient	create(java.lang.String bindAddress, int port) Bind a new TCP client to the specified connect address and port.
protected ContextHandler<SocketChannel>	doHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler, MonoSink<NettyContext> sink, boolean secure, java.net.SocketAddress providedAddress, ChannelPool pool, java.util.function.Consumer<? super Channel> onSetup) Create a ContextHandler for AbstractBootstrap.handler()
Mono<? extends NettyContext>	newHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler) Prepare a BiFunction IO handler that will react on a new connected state each time the returned Mono is subscribed.
protected Mono<NettyContext>	newHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler, java.net.InetSocketAddress address, boolean secure, java.util.function.Consumer<? super Channel> onSetup)
ClientOptions	options() Get a copy of the ClientOptions currently in effect.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.ipc.netty.NettyConnector

start, start, startAndAwait, startAndAwait

Field Detail

EMPTY

protected static final ChannelOperations.OnNew EMPTY

Constructor Detail

TcpClient

protected TcpClient(TcpClient.Builder builder)

TcpClient

protected TcpClient(ClientOptions options)

Method Detail

create

public static TcpClient create()

Bind a new TCP client to the localhost on port 12012.

The type of emitted data or received data is ByteBuf

Returns:

a new TcpClient

create

public static TcpClient create(java.lang.String bindAddress)

Bind a new TCP client to the specified connect address and port 12012.

The type of emitted data or received data is ByteBuf

Parameters:

bindAddress - the address to connect to on port 12012

Returns:

a new TcpClient

create

public static TcpClient create(int port)

Bind a new TCP client to "localhost" on the the specified port.

The type of emitted data or received data is ByteBuf

Parameters:

port - the port to connect to on "localhost"

Returns:

a new TcpClient

create

public static TcpClient create(java.lang.String bindAddress,
                               int port)

Bind a new TCP client to the specified connect address and port.

The type of emitted data or received data is ByteBuf

Parameters:

bindAddress - the address to connect to

port - the port to connect to

Returns:

a new TcpClient

create

public static TcpClient create(java.util.function.Consumer<? super ClientOptions.Builder<?>> options)

Bind a new TCP client to the specified connect address and port.

The type of emitted data or received data is ByteBuf

Parameters:

options - ClientOptions configuration input

Returns:

a new TcpClient

builder

public static TcpClient.Builder builder()

Creates a builder for TcpClient

Returns:

a new TcpClient builder

newHandler

public final Mono<? extends NettyContext> newHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler)

Description copied from interface: NettyConnector

Prepare a BiFunction IO handler that will react on a new connected state each time the returned Mono is subscribed. This NettyConnector shouldn't assume any state related to the individual created/cleaned resources.

The IO handler will return Publisher to signal when to terminate the underlying resource channel.

Specified by:

newHandler in interface NettyConnector<NettyInbound,NettyOutbound>

Parameters:

handler - the in/out callback returning a closing publisher

Returns:

a Mono completing with a Disposable token to dispose the active handler (server, client connection...) or failing with the connection error.

options

public final ClientOptions options()

Get a copy of the ClientOptions currently in effect.

Returns:

the client options

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newHandler

protected Mono<NettyContext> newHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler,
                                        java.net.InetSocketAddress address,
                                        boolean secure,
                                        java.util.function.Consumer<? super Channel> onSetup)

Parameters:

handler -

address -

secure -

onSetup -

Returns:

a new Mono to connect on subscribe

doHandler

protected ContextHandler<SocketChannel> doHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler,
                                                  MonoSink<NettyContext> sink,
                                                  boolean secure,
                                                  java.net.SocketAddress providedAddress,
                                                  ChannelPool pool,
                                                  java.util.function.Consumer<? super Channel> onSetup)

Create a ContextHandler for AbstractBootstrap.handler()

Parameters:

handler - user provided in/out handler

sink - user provided bind handler

secure - if operation should be secured

pool - if channel pool

onSetup - if operation has local setup callback

Returns:

a new ContextHandler