reactor.ipc.netty.tcp

Class TcpServer

java.lang.Object

reactor.ipc.netty.tcp.TcpServer

All Implemented Interfaces:

NettyConnector<NettyInbound,NettyOutbound>

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

* A TCP server connector.

Author:

Stephane Maldini, Violeta Georgieva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpServer.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TcpServer(ServerOptions options)
protected	TcpServer(TcpServer.Builder builder)

Method Summary

Modifier and Type	Method and Description
static TcpServer.Builder	builder() Creates a builder for TcpServer
static TcpServer	create() Bind a new TCP server to "localhost" on a randomly assigned port.
static TcpServer	create(java.util.function.Consumer<? super ServerOptions.Builder<?>> options) Bind a new TCP server to the bind address and port provided through the options.
static TcpServer	create(int port) Bind a new TCP server to "localhost" on the given port.
static TcpServer	create(java.lang.String bindAddress) Bind a new TCP server to the given bind address on a randomly assigned port.
static TcpServer	create(java.lang.String bindAddress, int port) Bind a new TCP server to the given bind address and port.
protected ContextHandler<io.netty.channel.Channel>	doHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler, reactor.core.publisher.MonoSink<NettyContext> sink) Create a ContextHandler for ServerBootstrap.childHandler()
protected io.netty.handler.logging.LoggingHandler	loggingHandler() Return the current logging handler for the server
reactor.core.publisher.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.
ServerOptions	options() Get a copy of the ServerOptions 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

Constructor Detail

TcpServer

protected TcpServer(TcpServer.Builder builder)

TcpServer

protected TcpServer(ServerOptions options)

Parameters:

options - server options

Method Detail

create

public static TcpServer create()

Bind a new TCP server to "localhost" on a randomly assigned port.

The assigned port can be found once a handler has been bound, using NettyContext.address() and its getPort() method.

Handlers will run on the same thread they have been receiving IO events. The type of emitted data or received data is ByteBuf

Returns:

a new TcpServer

create

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

Bind a new TCP server to the bind address and port provided through the options. Use 0 to let the system assign a random port, or NettyOptions.DEFAULT_PORT once to use a global default port.

Handlers will run on the same thread they have been receiving IO events. The type of emitted data or received data is ByteBuf

Parameters:

options - ServerOptions configuration input

Returns:

a new TcpServer

create

public static TcpServer create(int port)

Bind a new TCP server to "localhost" on the given port. Use 0 to let the system assign a random port, or NettyOptions.DEFAULT_PORT once to use a global default port.

Handlers will run on the same thread they have been receiving IO events. The type of emitted data or received data is ByteBuf

Parameters:

port - the port to listen on loopback

Returns:

a new TcpServer

create

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

Bind a new TCP server to the given bind address on a randomly assigned port.

The assigned port can be found once a handler has been bound, using NettyContext.address() and its getPort() method.

Handlers will run on the same thread they have been receiving IO events. The type of emitted data or received data is ByteBuf

Parameters:

bindAddress - bind address (e.g. "127.0.0.1") to create the server on the default port

Returns:

a new TcpServer

create

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

Bind a new TCP server to the given bind address and port. Use 0 to let the system assign a random port, or NettyOptions.DEFAULT_PORT once to use a global default port.

Handlers will run on the same thread they have been receiving IO events. The type of emitted data or received data is ByteBuf

Parameters:

bindAddress - bind address (e.g. "127.0.0.1") to create the server on the passed port

port - the port to listen on the passed bind address

Returns:

a new TcpServer

builder

public static TcpServer.Builder builder()

Creates a builder for TcpServer

Returns:

a new TcpServer builder

newHandler

public final reactor.core.publisher.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 ServerOptions options()

Get a copy of the ServerOptions currently in effect.

Returns:

the server options

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

loggingHandler

protected io.netty.handler.logging.LoggingHandler loggingHandler()

Return the current logging handler for the server

Returns:

the current logging handler for the server

doHandler

protected ContextHandler<io.netty.channel.Channel> doHandler(java.util.function.BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<java.lang.Void>> handler,
                                                             reactor.core.publisher.MonoSink<NettyContext> sink)

Create a ContextHandler for ServerBootstrap.childHandler()

Parameters:

handler - user provided in/out handler

sink - user provided bind handler

Returns:

a new ContextHandler