reactor.io.net

Class Spec.TcpClientSpec<IN,OUT>

java.lang.Object

reactor.bus.spec.DispatcherComponentSpec<Spec.TcpClientSpec<IN,OUT>,TcpClient<IN,OUT>>

reactor.io.net.Spec.TcpClientSpec<IN,OUT>

Type Parameters:

IN - The type that will be received by the client

OUT - The type that will be sent by the client

All Implemented Interfaces:

Supplier<TcpClient<IN,OUT>>

Enclosing interface:

Spec

public static class Spec.TcpClientSpec<IN,OUT>
extends DispatcherComponentSpec<Spec.TcpClientSpec<IN,OUT>,TcpClient<IN,OUT>>

A helper class for specifying a TcpClient

Author:

Jon Brisbin, Stephane Maldini

Method Summary

Modifier and Type	Method and Description
Spec.TcpClientSpec<IN,OUT>	codec(Codec<Buffer,IN,OUT> codec) The Codec to use to encode and decode data.
protected TcpClient<IN,OUT>	configure(Dispatcher dispatcher, Environment environment)
Spec.TcpClientSpec<IN,OUT>	connect(InetSocketAddress connectAddress) The address to which this client should connect.
Spec.TcpClientSpec<IN,OUT>	connect(String host, int port) The host and port to which this client should connect.
Spec.TcpClientSpec<IN,OUT>	connect(Supplier<InetSocketAddress> connectAddress) The eventual address to which this client should connect.
Spec.TcpClientSpec<IN,OUT>	options(ClientSocketOptions options) Set the common ClientSocketOptions for connections made in this client.
Spec.TcpClientSpec<IN,OUT>	rawData(boolean israw) Bypass any Reactor Buffer encoding for received data
Spec.TcpClientSpec<IN,OUT>	ssl(SslOptions sslOptions) Set the options to use for configuring SSL.

Methods inherited from class reactor.bus.spec.DispatcherComponentSpec

defaultDispatcher, dispatcher, dispatcher, env, get, synchronousDispatcher

Methods inherited from class java.lang.Object

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

Method Detail

options

public Spec.TcpClientSpec<IN,OUT> options(ClientSocketOptions options)

Set the common ClientSocketOptions for connections made in this client.

Parameters:

options - The socket options to apply to new connections.

Returns:

this

ssl

public Spec.TcpClientSpec<IN,OUT> ssl(@Nullable
                                      SslOptions sslOptions)

Set the options to use for configuring SSL. Setting this to null means don't use SSL at all (the default).

Parameters:

sslOptions - The options to set when configuring SSL

Returns:

this

connect

public Spec.TcpClientSpec<IN,OUT> connect(@Nonnull
                                          String host,
                                          int port)

The host and port to which this client should connect.

Parameters:

host - The host to connect to.

port - The port to connect to.

Returns:

this

connect

public Spec.TcpClientSpec<IN,OUT> connect(@Nonnull
                                          InetSocketAddress connectAddress)

The address to which this client should connect.

Parameters:

connectAddress - The address to connect to.

Returns:

this

connect

public Spec.TcpClientSpec<IN,OUT> connect(@Nonnull
                                          Supplier<InetSocketAddress> connectAddress)

The eventual address to which this client should connect.

Parameters:

connectAddress - The address to connect to.

Returns:

this

codec

public Spec.TcpClientSpec<IN,OUT> codec(@Nullable
                                        Codec<Buffer,IN,OUT> codec)

The Codec to use to encode and decode data.

Parameters:

codec - The codec to use.

Returns:

this

rawData

public Spec.TcpClientSpec<IN,OUT> rawData(boolean israw)

Bypass any Reactor Buffer encoding for received data

Parameters:

israw - to enable raw data transfer from the server (e.g. ByteBuf from Netty).

Returns:

this

configure

protected TcpClient<IN,OUT> configure(Dispatcher dispatcher,
                                      Environment environment)

Specified by:

configure in class DispatcherComponentSpec<Spec.TcpClientSpec<IN,OUT>,TcpClient<IN,OUT>>