HttpServerImpl (RxJava Javadoc 0.5.2-RC1)

java.lang.Object
- io.reactivex.netty.protocol.http.server.HttpServer<I,O>
- - io.reactivex.netty.protocol.http.server.HttpServerImpl<I,O>

All Implemented Interfaces:

io.reactivex.netty.events.EventSource<HttpServerEventsListener>
```
public final class HttpServerImpl<I,O>
extends HttpServer<I,O>
```

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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.
`<II,OO> HttpServer<II,OO>`	`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> HttpServer<I,O>`	`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> HttpServer<I,O>`	`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.
`HttpServer<I,O>`	`enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel)` Creates a new client instances, inheriting all configurations from this client and enabling wire logging at the passed level for the newly created client instance.
`java.net.SocketAddress`	`getServerAddress()` Returns the address at which this server is running.
`int`	`getServerPort()` Returns the port at which this server is running.
`<II,OO> HttpServer<II,OO>`	`pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)` Creates a new client instances, inheriting all configurations from this client and using the passed action to configure all the connections created by the newly created client instance.
`HttpServer<I,O>`	`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.
`HttpServer<I,O>`	`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.
`HttpServer<I,O>`	`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.
`HttpServer<I,O>`	`sendHttp10ResponseFor10Request(boolean sendHttp10ResponseFor10Request)` According to the specification, an HTTP server must send the highest HTTP version response, it is compatible with.
`void`	`shutdown()` Shutdown this server and waits till the server socket is closed.
`HttpServer<I,O>`	`start(RequestHandler<I,O> requestHandler)` Starts this server.
`rx.Subscription`	`subscribe(HttpServerEventsListener listener)`
`HttpServer<I,O>`	`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.http.server.HttpServer
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

- Method Detail
  - channelOption
```
public <T> HttpServer<I,O> channelOption(io.netty.channel.ChannelOption<T> option,
                                         T value)
```
    Description copied from class: HttpServer
    
    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 HttpServer<I,O>
    
    Parameters:
    
    option - Option to add.
    
    value - Value for the option.
    
    Returns:
    
    A new HttpServer instance.
  - clientChannelOption
```
public <T> HttpServer<I,O> clientChannelOption(io.netty.channel.ChannelOption<T> option,
                                               T value)
```
    Description copied from class: HttpServer
    
    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 HttpServer<I,O>
    
    Parameters:
    
    option - Option to add.
    
    value - Value for the option.
    
    Returns:
    
    A new HttpServer instance.
  - addChannelHandlerFirst
```
public <II,OO> HttpServer<II,OO> addChannelHandlerFirst(java.lang.String name,
                                                        rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Description copied from class: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerFirst in class HttpServer<I,O>
    
    Parameters:
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpServer instance.
  - addChannelHandlerFirst
```
public <II,OO> HttpServer<II,OO> addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                        java.lang.String name,
                                                        rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Description copied from class: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerFirst in class HttpServer<I,O>
    
    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 HttpServer instance.
  - addChannelHandlerLast
```
public <II,OO> HttpServer<II,OO> addChannelHandlerLast(java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Description copied from class: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerLast in class HttpServer<I,O>
    
    Parameters:
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpServer instance.
  - addChannelHandlerLast
```
public <II,OO> HttpServer<II,OO> addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                       java.lang.String name,
                                                       rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Description copied from class: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerLast in class HttpServer<I,O>
    
    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 HttpServer instance.
  - addChannelHandlerBefore
```
public <II,OO> HttpServer<II,OO> addChannelHandlerBefore(java.lang.String baseName,
                                                         java.lang.String name,
                                                         rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Description copied from class: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerBefore in class HttpServer<I,O>
    
    Parameters:
    
    baseName - the name of the existing handler
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpServer instance.
  - addChannelHandlerBefore
```
public <II,OO> HttpServer<II,OO> 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: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerBefore in class HttpServer<I,O>
    
    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 HttpServer instance.
  - addChannelHandlerAfter
```
public <II,OO> HttpServer<II,OO> addChannelHandlerAfter(java.lang.String baseName,
                                                        java.lang.String name,
                                                        rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Description copied from class: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerAfter in class HttpServer<I,O>
    
    Parameters:
    
    baseName - the name of the existing handler
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpServer instance.
  - addChannelHandlerAfter
```
public <II,OO> HttpServer<II,OO> 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: HttpServer
    
    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 HttpServer.pipelineConfigurator(Action1) will be more convenient.
    
    Specified by:
    
    addChannelHandlerAfter in class HttpServer<I,O>
    
    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 HttpServer instance.
  - pipelineConfigurator
```
public <II,OO> HttpServer<II,OO> pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)
```
    Description copied from class: HttpServer
    
    Creates a new client instances, inheriting all configurations from this client and using the passed action to configure all the connections created by the newly created client instance.
    
    Specified by:
    
    pipelineConfigurator in class HttpServer<I,O>
    
    Parameters:
    
    pipelineConfigurator - Action to configure ChannelPipeline.
    
    Returns:
    
    A new HttpServer instance.
  - secure
```
public HttpServer<I,O> secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory)
```
    Description copied from class: HttpServer
    
    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, HttpServer.secure(SSLEngine) can be used.
    
    Specified by:
    
    secure in class HttpServer<I,O>
    
    Parameters:
    
    sslEngineFactory - Factory for all secured connections created by the newly created server instance.
    
    Returns:
    
    A new HttpServer instance.
  - secure
```
public HttpServer<I,O> secure(javax.net.ssl.SSLEngine sslEngine)
```
    Description copied from class: HttpServer
    
    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, HttpServer.secure(Func1) )} can be used.
    
    Specified by:
    
    secure in class HttpServer<I,O>
    
    Parameters:
    
    sslEngine - SSLEngine for all secured connections created by the newly created server instance.
    
    Returns:
    
    A new HttpServer instance.
  - secure
```
public HttpServer<I,O> secure(io.reactivex.netty.ssl.SslCodec sslCodec)
```
    Description copied from class: HttpServer
    
    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, HttpServer.secure(Func1) or HttpServer.secure(SSLEngine) will be enough.
    
    Specified by:
    
    secure in class HttpServer<I,O>
    
    Parameters:
    
    sslCodec - SslCodec for all secured connections created by the newly created server instance.
    
    Returns:
    
    A new HttpServer instance.
  - unsafeSecure
```
public HttpServer<I,O> unsafeSecure()
```
    Description copied from class: HttpServer
    
    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 HttpServer<I,O>
    
    Returns:
    
    A new HttpServer instance.
  - enableWireLogging
```
public HttpServer<I,O> enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel)
```
    Description copied from class: HttpServer
    
    Creates a new client instances, inheriting all configurations from this client and enabling wire logging at the passed level for the newly created client instance.
    
    Specified by:
    
    enableWireLogging in class HttpServer<I,O>
    
    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 HttpServer instance.
  - sendHttp10ResponseFor10Request
```
public HttpServer<I,O> sendHttp10ResponseFor10Request(boolean sendHttp10ResponseFor10Request)
```
    Description copied from class: HttpServer
    
    According to the specification, an HTTP server must send the highest HTTP version response, it is compatible with. Since, all implementations of this server are expected to be HTTP 1.1 compatible, they should always send the response for 1.1. However, in some cases, if desired, this behavior can be overridden to send 1.0 response for 1.0 request. If so desired, the behavior can be enabled/ disabled by this method.
    
    Specified by:
    
    sendHttp10ResponseFor10Request in class HttpServer<I,O>
    
    Parameters:
    
    sendHttp10ResponseFor10Request - If true then sends 1.0 version response for 1.0 request.
    
    Returns:
    
    A new HttpServer instance.
  - getServerPort
```
public int getServerPort()
```
    Description copied from class: HttpServer
    
    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 HttpServer<I,O>
    
    Returns:
    
    The port at which this server is running.
  - getServerAddress
```
public java.net.SocketAddress getServerAddress()
```
    Description copied from class: HttpServer
    
    Returns the address at which this server is running.
    
    Specified by:
    
    getServerAddress in class HttpServer<I,O>
    
    Returns:
    
    The address at which this server is running.
  - start
```
public HttpServer<I,O> start(RequestHandler<I,O> requestHandler)
```
    Description copied from class: HttpServer
    
    Starts this server.
    
    Specified by:
    
    start in class HttpServer<I,O>
    
    Parameters:
    
    requestHandler - Connection handler that will handle any new client connections to this server.
    
    Returns:
    
    This server.
  - shutdown
```
public void shutdown()
```
    Description copied from class: HttpServer
    
    Shutdown this server and waits till the server socket is closed.
    
    Specified by:
    
    shutdown in class HttpServer<I,O>
  - awaitShutdown
```
public void awaitShutdown()
```
    Description copied from class: HttpServer
    
    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 HttpServer<I,O>
  - awaitShutdown
```
public void awaitShutdown(long duration,
                          java.util.concurrent.TimeUnit timeUnit)
```
    Description copied from class: HttpServer
    
    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 HttpServer<I,O>
    
    Parameters:
    
    duration - Duration to wait for shutdown.
    
    timeUnit - Timeunit for the duration to wait for shutdown.
  - subscribe
```
public rx.Subscription subscribe(HttpServerEventsListener listener)
```

RxJava

Class HttpServerImpl<I,O>

Method Summary

Methods inherited from class io.reactivex.netty.protocol.http.server.HttpServer

Methods inherited from class java.lang.Object

Method Detail

channelOption

clientChannelOption

addChannelHandlerFirst

addChannelHandlerFirst

addChannelHandlerLast

addChannelHandlerLast

addChannelHandlerBefore

addChannelHandlerBefore

addChannelHandlerAfter

addChannelHandlerAfter

pipelineConfigurator

secure

secure

secure

unsafeSecure

enableWireLogging

sendHttp10ResponseFor10Request

getServerPort

getServerAddress

start

shutdown

awaitShutdown

awaitShutdown

subscribe