bayou.http

Class HttpServer

java.lang.Object

bayou.http.HttpServer

public class HttpServer
extends Object

Http server.

Each server has an HttpHandler which creates a response for every request.

Configuration can be done on the HttpServerConf before server start, for example

     HttpServer server = new HttpServer(handler);
     server.conf()
         .port( 8080 )
         .trafficDump( System.out::print )
         ;
     server.start();
 

Life Cycle

The server can be in 4 states: init, accepting, acceptingPaused, acceptingStopped.

After start(), the server is in accepting state. New requests are accepted.

If pauseAccepting() is called, the server is in acceptingPaused state. New requests are not accepted. This is useful to protect the server when some resources are about to be exhausted. The server socket ports are still owned by this server. The server can be resumed to accepting state by resumeAccepting().

After stopAccepting(), the server is in acceptingStopped state. New requests are not accepted. The server socket ports are freed and can be grabbed by another server. Existing requests are still being processed. Their connections will be closed after their responses are written. Check the number of live connections by getConnectionCount().

The stopAll() call will stop accepting new requests and abort outstanding requests.

You can use stop(graceTimeout) to gracefully stop the server.

Constructor Summary

Constructors

Constructor and Description
HttpServer(HttpHandler handler) Create an HttpServer.
HttpServer(HttpServerConf conf, HttpHandler handler) Create an HttpServer.

Method Summary

Instance Methods
HttpServerConf	conf() Get the HttpServerConf of this server.
void	addUpgrader(String protocol, HttpUpgrader upgrader) Add an HttpUpgrader for the protocol.
void	start() Start the server.
Set<ServerSocketChannel>	getServerSockets() Get server sockets.
int	getConnectionCount() Get the number of connections.
void	pauseAccepting() Pausing accepting new requests.
void	resumeAccepting() Resume accepting new requests.
void	stopAccepting() Stop accepting new requests.
void	stopAll() Stop accepting new requests and abort outstanding requests.
void	stop(Duration graceTimeout) Gracefully stop the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServer

public HttpServer(HttpHandler handler)

Create an HttpServer.

Equivalent to new HttpServer( new HttpServerConf(), handler ).

HttpServer

public HttpServer(HttpServerConf conf,
                  HttpHandler handler)

Create an HttpServer.

After the constructor call, the `conf` object can be accessed through conf(), and it can be modified as long as the server is not started.

Method Detail

conf

public HttpServerConf conf()

Get the HttpServerConf of this server.

Changes to configuration must be done before the server is started.

addUpgrader

public void addUpgrader(String protocol,
                        HttpUpgrader upgrader)

Add an HttpUpgrader for the protocol.

This method must be called before the server is started.

start

public void start()
           throws Exception

Start the server. See Life Cycle.

Throws:

Exception

getServerSockets

public Set<ServerSocketChannel> getServerSockets()

Get server sockets.

Returns an empty set if the server is not started, or has been stopped.

getConnectionCount

public int getConnectionCount()

Get the number of connections.

pauseAccepting

public void pauseAccepting()

Pausing accepting new requests. See Life Cycle.

resumeAccepting

public void resumeAccepting()

Resume accepting new requests. See Life Cycle.

stopAccepting

public void stopAccepting()

Stop accepting new requests. See Life Cycle.

stopAll

public void stopAll()

Stop accepting new requests and abort outstanding requests. See Life Cycle.

stop

public void stop(Duration graceTimeout)

Gracefully stop the server.

1. Call stopAccepting() to stop accepting new requests.
2. Wait for getConnectionCount() to reach 0, within `graceTimeout`.
3. Call stopAll().