io.reactivex.netty.protocol.tcp.server

Class TcpServerImpl<R,W>

java.lang.Object

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

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

All Implemented Interfaces:

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

public class TcpServerImpl<R,W>
extends TcpServer<R,W>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TcpServerImpl.ServerStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicReference<TcpServerImpl.ServerStatus>	serverStateRef

Constructor Summary

Constructors

Constructor and Description
TcpServerImpl(java.net.SocketAddress socketAddress)
TcpServerImpl(java.net.SocketAddress socketAddress, io.netty.channel.EventLoopGroup parent, io.netty.channel.EventLoopGroup child, java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass)

Method Summary

Modifier and Type	Method and Description
<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.
<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.
<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.
<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.
<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.
<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.
<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.
<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.
void	awaitShutdown() Waits for the shutdown of this server.
void	awaitShutdown(long duration, java.util.concurrent.TimeUnit timeUnit) Waits for the shutdown of this server, waiting a maximum of the passed duration.
<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.
<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.
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.
TcpServerEventPublisher	getEventPublisher() Returns the event publisher for this server.
java.net.SocketAddress	getServerAddress() Returns the address at which this server is running.
int	getServerPort() Returns the port at which this server is running.
<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.
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.
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.
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.
void	shutdown() Shutdown this server and waits till the server socket is closed.
TcpServer<R,W>	start(ConnectionHandler<R,W> connectionHandler) Starts this server.
rx.Subscription	subscribe(TcpServerEventListener listener)
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 io.reactivex.netty.protocol.tcp.server.TcpServer

newServer, newServer, newServer, newServer, newServer, newServer, newServer

Methods inherited from class java.lang.Object

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

Field Detail

serverStateRef

protected final java.util.concurrent.atomic.AtomicReference<TcpServerImpl.ServerStatus> serverStateRef

Constructor Detail

TcpServerImpl

public TcpServerImpl(java.net.SocketAddress socketAddress)

TcpServerImpl

public TcpServerImpl(java.net.SocketAddress socketAddress,
                     io.netty.channel.EventLoopGroup parent,
                     io.netty.channel.EventLoopGroup child,
                     java.lang.Class<? extends io.netty.channel.ServerChannel> channelClass)

Method Detail

channelOption

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

Description copied from class: TcpServer

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.

Specified by:

channelOption in class TcpServer<R,W>

Parameters:

option - Option to add.

value - Value for the option.

Returns:

A new TcpServer instance.

clientChannelOption

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

Description copied from class: TcpServer

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.

Specified by:

clientChannelOption in class TcpServer<R,W>

Parameters:

option - Option to add.

value - Value for the option.

Returns:

A new TcpServer instance.

addChannelHandlerFirst

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

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerFirst in class TcpServer<R,W>

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerFirst

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

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerFirst in class TcpServer<R,W>

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 <RR,WW> TcpServer<RR,WW> addChannelHandlerLast(java.lang.String name,
                                                      rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerLast in class TcpServer<R,W>

Parameters:

name - Name of the handler.

handlerFactory - Factory to create handler instance to add.

Returns:

A new TcpServer instance.

addChannelHandlerLast

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

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerLast in class TcpServer<R,W>

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 <RR,WW> TcpServer<RR,WW> addChannelHandlerBefore(java.lang.String baseName,
                                                        java.lang.String name,
                                                        rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerBefore in class TcpServer<R,W>

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 <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)

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerBefore in class TcpServer<R,W>

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 <RR,WW> TcpServer<RR,WW> addChannelHandlerAfter(java.lang.String baseName,
                                                       java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerAfter in class TcpServer<R,W>

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 <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)

Description copied from class: TcpServer

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 TcpServer.pipelineConfigurator(Action1) will be more convenient.

Specified by:

addChannelHandlerAfter in class TcpServer<R,W>

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 <RR,WW> TcpServer<RR,WW> pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)

Description copied from class: TcpServer

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.

Specified by:

pipelineConfigurator in class TcpServer<R,W>

Parameters:

pipelineConfigurator - Action to configure ChannelPipeline.

Returns:

A new TcpServer instance.

secure

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

Description copied from class: TcpServer

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, TcpServer.secure(SSLEngine) can be used.

Specified by:

secure in class TcpServer<R,W>

Parameters:

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

Returns:

A new TcpServer instance.

secure

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

Description copied from class: TcpServer

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, TcpServer.secure(Func1) )} can be used.

Specified by:

secure in class TcpServer<R,W>

Parameters:

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

Returns:

A new TcpServer instance.

secure

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

Description copied from class: TcpServer

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, TcpServer.secure(Func1) or TcpServer.secure(SSLEngine) will be enough.

Specified by:

secure in class TcpServer<R,W>

Parameters:

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

Returns:

A new TcpServer instance.

unsafeSecure

public TcpServer<R,W> unsafeSecure()

Description copied from class: TcpServer

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.

Specified by:

unsafeSecure in class TcpServer<R,W>

Returns:

A new TcpServer instance.

enableWireLogging

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

Description copied from class: TcpServer

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.

Specified by:

enableWireLogging in class TcpServer<R,W>

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 int getServerPort()

Description copied from class: TcpServer

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.

Specified by:

getServerPort in class TcpServer<R,W>

Returns:

The port at which this server is running.

getServerAddress

public java.net.SocketAddress getServerAddress()

Description copied from class: TcpServer

Returns the address at which this server is running.

Specified by:

getServerAddress in class TcpServer<R,W>

Returns:

The address at which this server is running.

start

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

Description copied from class: TcpServer

Starts this server.

Specified by:

start in class TcpServer<R,W>

Parameters:

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

Returns:

This server.

shutdown

public void shutdown()

Description copied from class: TcpServer

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

Specified by:

shutdown in class TcpServer<R,W>

awaitShutdown

public void awaitShutdown()

Description copied from class: TcpServer

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

Specified by:

awaitShutdown in class TcpServer<R,W>

awaitShutdown

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

Description copied from class: TcpServer

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.

Specified by:

awaitShutdown in class TcpServer<R,W>

Parameters:

duration - Duration to wait for shutdown.

timeUnit - Timeunit for the duration to wait for shutdown.

getEventPublisher

public TcpServerEventPublisher getEventPublisher()

Description copied from class: TcpServer

Returns the event publisher for this server.

Specified by:

getEventPublisher in class TcpServer<R,W>

Returns:

The event publisher for this server.

subscribe

public rx.Subscription subscribe(TcpServerEventListener listener)