io.reactivex.netty.protocol.tcp.server

Class TcpServer<R,W>

java.lang.Object

io.reactivex.netty.protocol.tcp.server.TcpServer<R,W>

Type Parameters:

R - The type of objects read from this server.

W - The type of objects written to this server.

All Implemented Interfaces:

io.reactivex.netty.events.EventSource<TcpServerEventListener>

Direct Known Subclasses:

TcpServerImpl

public abstract class TcpServer<R,W>
extends java.lang.Object
implements io.reactivex.netty.events.EventSource<TcpServerEventListener>

A TCP server.

Immutability

An instance of this server is immutable and all mutations produce a new server instance.

Constructor Summary

Constructors

Constructor and Description
TcpServer()

Method Summary

Modifier and Type	Method and Description
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerAfter(java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerBefore(java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerFirst(java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract <RR,WW> TcpServer<RR,WW>	addChannelHandlerLast(java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory) Adds a ChannelHandler to ChannelPipeline for all connections created by this server.
abstract void	awaitShutdown() Waits for the shutdown of this server.
abstract void	awaitShutdown(long duration, java.util.concurrent.TimeUnit timeUnit) Waits for the shutdown of this server, waiting a maximum of the passed duration.
abstract <T> TcpServer<R,W>	channelOption(io.netty.channel.ChannelOption<T> option, T value) Creates a new server instance, inheriting all configurations from this server and adding a ChannelOption for the server socket created by the newly created server instance.
abstract <T> TcpServer<R,W>	clientChannelOption(io.netty.channel.ChannelOption<T> option, T value) Creates a new server instance, inheriting all configurations from this server and adding a ChannelOption for the client socket created by the newly created server instance.
abstract TcpServer<R,W>	enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel) Creates a new server instances, inheriting all configurations from this server and enabling wire logging at the passed level for the newly created server instance.
abstract TcpServerEventPublisher	getEventPublisher() Returns the event publisher for this server.
abstract java.net.SocketAddress	getServerAddress() Returns the address at which this server is running.
abstract int	getServerPort() Returns the port at which this server is running.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer() Creates a new server using an ephemeral port.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer(int port) Creates a new server using the passed port.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer(int port, io.netty.channel.EventLoopGroup eventLoopGroup, java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass) Creates a new server using the passed port.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer(int port, io.netty.channel.EventLoopGroup acceptGroup, io.netty.channel.EventLoopGroup clientGroup, java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass) Creates a new server using the passed port.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer(java.net.SocketAddress socketAddress) Creates a new server using the passed address.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer(java.net.SocketAddress socketAddress, io.netty.channel.EventLoopGroup eventLoopGroup, java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass) Creates a new server using the passed address.
static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	newServer(java.net.SocketAddress socketAddress, io.netty.channel.EventLoopGroup acceptGroup, io.netty.channel.EventLoopGroup clientGroup, java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass) Creates a new server using the passed address.
abstract <RR,WW> TcpServer<RR,WW>	pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator) Creates a new server instances, inheriting all configurations from this server and using the passed action to configure all the connections created by the newly created server instance.
abstract TcpServer<R,W>	secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory) Creates a new server instances, inheriting all configurations from this server and using the passed sslEngineFactory for all secured connections accepted by the newly created server instance.
abstract TcpServer<R,W>	secure(io.reactivex.netty.ssl.SslCodec sslCodec) Creates a new server instances, inheriting all configurations from this server and using the passed sslCodec for all secured connections accepted by the newly created server instance.
abstract TcpServer<R,W>	secure(javax.net.ssl.SSLEngine sslEngine) Creates a new server instances, inheriting all configurations from this server and using the passed sslEngine for all secured connections accepted by the newly created server instance.
abstract void	shutdown() Shutdown this server and waits till the server socket is closed.
abstract TcpServer<R,W>	start(ConnectionHandler<R,W> connectionHandler) Starts this server.
abstract TcpServer<R,W>	unsafeSecure() Creates a new server instances, inheriting all configurations from this server and using a self-signed certificate for all secured connections accepted by the newly created server instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.netty.events.EventSource

subscribe

Constructor Detail

TcpServer

public TcpServer()

Method Detail

channelOption

public abstract <T> TcpServer<R,W> channelOption(io.netty.channel.ChannelOption<T> option,
                                                 T value)

Creates a new server instance, inheriting all configurations from this server and adding a ChannelOption for the server socket created by the newly created server instance.

Parameters:

option - Option to add.

value - Value for the option.

Returns:

A new TcpServer instance.

clientChannelOption

public abstract <T> TcpServer<R,W> clientChannelOption(io.netty.channel.ChannelOption<T> option,
                                                       T value)

Creates a new server instance, inheriting all configurations from this server and adding a ChannelOption for the client socket created by the newly created server instance.

Parameters:

option - Option to add.

value - Value for the option.

Returns:

A new TcpServer instance.

addChannelHandlerFirst

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerFirst(java.lang.String name,
                                                                rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerFirst

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                                java.lang.String name,
                                                                rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - The EventExecutorGroup which will be used to execute the ChannelHandler methods

name - The name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerLast

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerLast(java.lang.String name,
                                                               rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerLast

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                               java.lang.String name,
                                                               rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerBefore

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerBefore(java.lang.String baseName,
                                                                 java.lang.String name,
                                                                 rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

baseName - the name of the existing handler

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerBefore

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group,
                                                                 java.lang.String baseName,
                                                                 java.lang.String name,
                                                                 rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerAfter

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerAfter(java.lang.String baseName,
                                                                java.lang.String name,
                                                                rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

baseName - the name of the existing handler

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerAfter

public abstract <RR,WW> TcpServer<RR,WW> addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group,
                                                                java.lang.String baseName,
                                                                java.lang.String name,
                                                                rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Adds a ChannelHandler to ChannelPipeline for all connections created by this server. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to append

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

pipelineConfigurator

public abstract <RR,WW> TcpServer<RR,WW> pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)

Creates a new server instances, inheriting all configurations from this server and using the passed action to configure all the connections created by the newly created server instance.

Parameters:

pipelineConfigurator - Action to configure ChannelPipeline.

Returns:

A new TcpServer instance.

secure

public abstract TcpServer<R,W> secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory)

Creates a new server instances, inheriting all configurations from this server and using the passed sslEngineFactory for all secured connections accepted by the newly created server instance. If the SSLEngine instance can be statically, created, secure(SSLEngine) can be used.

Parameters:

sslEngineFactory - Factory for all secured connections created by the newly created server instance.

Returns:

A new TcpServer instance.

secure

public abstract TcpServer<R,W> secure(javax.net.ssl.SSLEngine sslEngine)

Creates a new server instances, inheriting all configurations from this server and using the passed sslEngine for all secured connections accepted by the newly created server instance. If the SSLEngine instance can not be statically, created, secure(Func1) )} can be used.

Parameters:

sslEngine - SSLEngine for all secured connections created by the newly created server instance.

Returns:

A new TcpServer instance.

secure

public abstract TcpServer<R,W> secure(io.reactivex.netty.ssl.SslCodec sslCodec)

Creates a new server instances, inheriting all configurations from this server and using the passed sslCodec for all secured connections accepted by the newly created server instance. This is required only when the SslHandler used by SslCodec is to be modified before adding to the ChannelPipeline. For most of the cases, secure(Func1) or secure(SSLEngine) will be enough.

Parameters:

sslCodec - SslCodec for all secured connections created by the newly created server instance.

Returns:

A new TcpServer instance.

unsafeSecure

public abstract TcpServer<R,W> unsafeSecure()

Creates a new server instances, inheriting all configurations from this server and using a self-signed certificate for all secured connections accepted by the newly created server instance. This is only for testing and should not be used for real production servers.

Returns:

A new TcpServer instance.

enableWireLogging

public abstract TcpServer<R,W> enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel)

Creates a new server instances, inheriting all configurations from this server and enabling wire logging at the passed level for the newly created server instance.

Parameters:

wireLoggingLevel - Logging level at which the wire logs will be logged. The wire logging will only be done if logging is enabled at this level for LoggingHandler

Returns:

A new TcpServer instance.

getServerPort

public abstract int getServerPort()

Returns the port at which this server is running. For servers using ephemeral ports, this would return the actual port used, only after the server is started.

Returns:

The port at which this server is running.

getServerAddress

public abstract java.net.SocketAddress getServerAddress()

Returns the address at which this server is running.

Returns:

The address at which this server is running.

start

public abstract TcpServer<R,W> start(ConnectionHandler<R,W> connectionHandler)

Starts this server.

Parameters:

connectionHandler - Connection handler that will handle any new server connections to this server.

Returns:

This server.

shutdown

public abstract void shutdown()

Shutdown this server and waits till the server socket is closed.

awaitShutdown

public abstract void awaitShutdown()

Waits for the shutdown of this server. This does not actually shutdown the server. It just waits for some other action to shutdown.

awaitShutdown

public abstract void awaitShutdown(long duration,
                                   java.util.concurrent.TimeUnit timeUnit)

Waits for the shutdown of this server, waiting a maximum of the passed duration. This does not actually shutdown the server. It just waits for some other action to shutdown.

Parameters:

duration - Duration to wait for shutdown.

timeUnit - Timeunit for the duration to wait for shutdown.

getEventPublisher

public abstract TcpServerEventPublisher getEventPublisher()

Returns the event publisher for this server.

Returns:

The event publisher for this server.

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer()

Creates a new server using an ephemeral port. The port used can be queried after starting this server, using getServerPort()

Returns:

A new TcpServer

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer(int port)

Creates a new server using the passed port.

Parameters:

port - Port for the server. 0 to use ephemeral port.

Returns:

A new TcpServer

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer(int port,
                                                                                   io.netty.channel.EventLoopGroup eventLoopGroup,
                                                                                   java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass)

Creates a new server using the passed port.

Parameters:

port - Port for the server. 0 to use ephemeral port.

eventLoopGroup - Eventloop group to be used for server as well as client sockets.

channelClass - The class to be used for server channel.

Returns:

A new TcpServer

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer(int port,
                                                                                   io.netty.channel.EventLoopGroup acceptGroup,
                                                                                   io.netty.channel.EventLoopGroup clientGroup,
                                                                                   java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass)

Creates a new server using the passed port.

Parameters:

port - Port for the server. 0 to use ephemeral port.

acceptGroup - Eventloop group to be used for server sockets.

clientGroup - Eventloop group to be used for client sockets.

channelClass - The class to be used for server channel.

Returns:

A new TcpServer

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer(java.net.SocketAddress socketAddress)

Creates a new server using the passed address.

Parameters:

socketAddress - Socket address for the server.

Returns:

A new TcpServer

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer(java.net.SocketAddress socketAddress,
                                                                                   io.netty.channel.EventLoopGroup eventLoopGroup,
                                                                                   java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass)

Creates a new server using the passed address.

Parameters:

socketAddress - Socket address for the server.

eventLoopGroup - Eventloop group to be used for server as well as client sockets.

channelClass - The class to be used for server channel.

Returns:

A new TcpServer

newServer

public static TcpServer<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newServer(java.net.SocketAddress socketAddress,
                                                                                   io.netty.channel.EventLoopGroup acceptGroup,
                                                                                   io.netty.channel.EventLoopGroup clientGroup,
                                                                                   java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass)

Creates a new server using the passed address.

Parameters:

socketAddress - Socket address for the server.

acceptGroup - Eventloop group to be used for server sockets.

clientGroup - Eventloop group to be used for client sockets.

channelClass - The class to be used for server channel.

Returns:

A new TcpServer