esa.httpserver

接口 HttpServer

所有已知实现类:

HttpServerImpl

public interface HttpServer

An http server to provide a way to handle http requests received from the clients. Also, this interface would be an entrance for bootstrapping a new instance of this http server.

Every instance of this HttpServer have a identity name() which also means that the different instance should be isolated with others.

All the requests received would be handled by the request handler you set by handle(Consumer).

方法概要

限定符和类型	方法和说明
SocketAddress	address() Returns the SocketAddress that the server is listening on.
void	await() Waits for this server to be closed.
void	awaitUninterruptibly() Waits for this server to be closed.
io.netty.channel.EventLoopGroup	bossGroup() Returns the boss EventLoopGroup which is used to accepting new connections.
void	close() Closes current server.
io.netty.util.concurrent.Future<Void>	closeFuture() Returns the Future which is notified when server is closed(probably by calling close()).
static HttpServer	create() Creates a new instance of HttpServer by the default options.
static HttpServer	create(ServerOptions options) Creates a new instance of HttpServer by the options.
static HttpServer	create(String name, ServerOptions options) Creates a new instance of HttpServer by the given name and options.
HttpServer	handle(Consumer<RequestHandle> h) Sets the handler for handing requests received.
io.netty.channel.EventLoopGroup	ioGroup() Returns the io EventLoopGroup which is used to handing I/O events.
HttpServer	listen(int port) Starts the server which is listening on the given port.
HttpServer	listen(SocketAddress address) Starts the server which is listening on the given address.
HttpServer	listen(String host, int port) Starts the server which is listening on the given host and port.
Metrics	metrics() Returns the metrics of current server.
String	name() Returns the identity name of this server.
HttpServer	onClose(Runnable closure) Adds a close hook which will be called when server is about to closing.
HttpServer	onConnected(Consumer<io.netty.channel.ChannelHandlerContext> h) Sets the handler for listening connection connected.
HttpServer	onDisconnected(Consumer<io.netty.channel.Channel> h) Sets the handler for listening connection disconnected.

方法详细资料

create

static HttpServer create()

Creates a new instance of HttpServer by the default options.

返回:

a new instance of HttpServer

create

static HttpServer create(ServerOptions options)

Creates a new instance of HttpServer by the options.

参数:

options - options

返回:

a new instance of HttpServer

create

static HttpServer create(String name,
                         ServerOptions options)

Creates a new instance of HttpServer by the given name and options.

参数:

name - server name

options - options

返回:

a new instance of HttpServer

handle

HttpServer handle(Consumer<RequestHandle> h)

Sets the handler for handing requests received.

参数:

h - handler

返回:

this

onConnected

HttpServer onConnected(Consumer<io.netty.channel.ChannelHandlerContext> h)

Sets the handler for listening connection connected.

参数:

h - handler

返回:

this

onDisconnected

HttpServer onDisconnected(Consumer<io.netty.channel.Channel> h)

Sets the handler for listening connection disconnected.

参数:

h - handler

返回:

this

onClose

HttpServer onClose(Runnable closure)

Adds a close hook which will be called when server is about to closing.

参数:

closure - hook

返回:

this

listen

HttpServer listen(int port)

Starts the server which is listening on the given port.

参数:

port - port to listen on

返回:

this

listen

HttpServer listen(String host,
                  int port)

Starts the server which is listening on the given host and port.

参数:

host - host to listen on

port - port to listen on

返回:

binding future

listen

HttpServer listen(SocketAddress address)

Starts the server which is listening on the given address.

参数:

address - address to listen on

返回:

binding future

name

String name()

Returns the identity name of this server.

!Note: this name would not be same with the name you passed in the create(String, ServerOptions) for avoiding passing the same many a time

返回:

server name

await

void await()
    throws InterruptedException

Waits for this server to be closed.

抛出:

InterruptedException

awaitUninterruptibly

void awaitUninterruptibly()

Waits for this server to be closed.

closeFuture

io.netty.util.concurrent.Future<Void> closeFuture()

Returns the Future which is notified when server is closed(probably by calling close()).

返回:

future

bossGroup

io.netty.channel.EventLoopGroup bossGroup()

Returns the boss EventLoopGroup which is used to accepting new connections.

返回:

boss EventLoopGroup or null if server is not running.

ioGroup

io.netty.channel.EventLoopGroup ioGroup()

Returns the io EventLoopGroup which is used to handing I/O events.

返回:

io EventLoopGroup or null if server is not running.

address

SocketAddress address()

Returns the SocketAddress that the server is listening on.

返回:

SocketAddress or null if server is not running.

metrics

Metrics metrics()

Returns the metrics of current server.

This method will never return null, but may return an Metrics which does not have any metrics.

返回:

metrics

close

void close()

Closes current server.