org.cauli.server.netty

类 NettyWebServer

java.lang.Object

org.cauli.server.netty.NettyWebServer

所有已实现的接口:

Endpoint<WebServer>, WebServer

public class NettyWebServer
extends Object
implements WebServer

字段概要

字段

限定符和类型	字段和说明
private org.jboss.netty.bootstrap.ServerBootstrap	bootstrap
private org.jboss.netty.channel.Channel	channel
private ConnectionTrackingHandler	connectionTrackingHandler
private static long	DEFAULT_STALE_CONNECTION_TIMEOUT
private Thread.UncaughtExceptionHandler	exceptionHandler
private Executor	executor
private List<ExecutorService>	executorServices
private List<HttpHandler>	handlers
private Thread.UncaughtExceptionHandler	ioExceptionHandler
private int	maxChunkSize
private int	maxContentLength
private int	maxHeaderSize
private int	maxInitialLineLength
protected long	nextId
private URI	publicUri
private SocketAddress	socketAddress
private SSLContext	sslContext
private long	staleConnectionTimeout
private StaleConnectionTrackingHandler	staleConnectionTrackingHandler

构造器概要

构造器

限定符	构造器和说明
	NettyWebServer(Executor executor, int port)
private	NettyWebServer(ExecutorService executorService, int port)
	NettyWebServer(Executor executor, SocketAddress socketAddress, URI publicUri)
	NettyWebServer(int port)

方法概要

方法

限定符和类型	方法和说明
NettyWebServer	add(HttpHandler handler) Add an HttpHandler.
NettyWebServer	add(String path, EventSourceHandler handler) Add a WebSocketHandler for dealing with WebSockets.
NettyWebServer	add(String path, HttpHandler handler) Add an HttpHandler that will only respond to a certain path (e.g "/some/page").
NettyWebServer	add(String path, WebSocketHandler handler) Add a WebSocketHandler for dealing with WebSockets.
NettyWebServer	connectionExceptionHandler(Thread.UncaughtExceptionHandler ioExceptionHandler) What to do when an exception occurs when attempting to read/write data from/to the underlying connection. e.g.
Executor	getExecutor() Get main work executor that all handlers will execute on.
int	getPort() Get base port that webserver is serving on.
URI	getUri() Get base URI that endpoint is serving on (or connected to).
boolean	isRunning()
private static URI	localUri(int port)
NettyWebServer	maxChunkSize(int maxChunkSize)
NettyWebServer	maxContentLength(int maxContentLength)
NettyWebServer	maxHeaderSize(int maxHeaderSize)
NettyWebServer	maxInitialLineLength(int maxInitialLineLength)
protected Object	nextId()
protected void	setupDefaultHandlers()
NettyWebServer	setupSsl(InputStream keyStore, String pass) Setup SSL/TLS handler This is shortcut for setupSsl(keyStore, pass, pass).
NettyWebServer	setupSsl(InputStream keyStore, String storePass, String keyPass) Setup SSL/TLS handler
private void	shutdownAndAwaitTermination(ExecutorService executorService)
NettyWebServer	staleConnectionTimeout(long millis) Number of milliseconds before a stale HTTP keep-alive connection is closed by the server.
Future<NettyWebServer>	start() Start in background.
Future<WebServer>	stop() Stop in background.
protected long	timestamp()
NettyWebServer	uncaughtExceptionHandler(Thread.UncaughtExceptionHandler exceptionHandler) What to do when an exception gets thrown in a handler.

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_STALE_CONNECTION_TIMEOUT

private static final long DEFAULT_STALE_CONNECTION_TIMEOUT

另请参阅:

常量字段值

socketAddress

private final SocketAddress socketAddress

publicUri

private final URI publicUri

handlers

private final List<HttpHandler> handlers

executorServices

private final List<ExecutorService> executorServices

executor

private final Executor executor

bootstrap

private org.jboss.netty.bootstrap.ServerBootstrap bootstrap

channel

private org.jboss.netty.channel.Channel channel

sslContext

private SSLContext sslContext

nextId

protected long nextId

exceptionHandler

private Thread.UncaughtExceptionHandler exceptionHandler

ioExceptionHandler

private Thread.UncaughtExceptionHandler ioExceptionHandler

connectionTrackingHandler

private ConnectionTrackingHandler connectionTrackingHandler

staleConnectionTrackingHandler

private StaleConnectionTrackingHandler staleConnectionTrackingHandler

staleConnectionTimeout

private long staleConnectionTimeout

maxInitialLineLength

private int maxInitialLineLength

maxHeaderSize

private int maxHeaderSize

maxChunkSize

private int maxChunkSize

maxContentLength

private int maxContentLength

构造器详细资料

NettyWebServer

public NettyWebServer(int port)

NettyWebServer

private NettyWebServer(ExecutorService executorService,
              int port)

NettyWebServer

public NettyWebServer(Executor executor,
              int port)

NettyWebServer

public NettyWebServer(Executor executor,
              SocketAddress socketAddress,
              URI publicUri)

方法详细资料

setupDefaultHandlers

protected void setupDefaultHandlers()

setupSsl

public NettyWebServer setupSsl(InputStream keyStore,
                      String pass)
                        throws WebbitException

从接口复制的说明: Endpoint

Setup SSL/TLS handler

This is shortcut for setupSsl(keyStore, pass, pass).

指定者:

setupSsl 在接口中 Endpoint<WebServer>

参数:

keyStore - Keystore InputStream

pass - Store and key password

返回:

current WebServer instance

抛出:

WebbitException - A problem loading the keystore

另请参阅:

#setupSsl(String, String, String)

setupSsl

public NettyWebServer setupSsl(InputStream keyStore,
                      String storePass,
                      String keyPass)
                        throws WebbitException

从接口复制的说明: WebServer

Setup SSL/TLS handler

指定者:

setupSsl 在接口中 WebServer

参数:

keyStore - Keystore InputStream

storePass - Store password

keyPass - Key password

返回:

current WebServer instance

抛出:

WebbitException - A problem loading the keystore

getUri

public URI getUri()

从接口复制的说明: Endpoint

Get base URI that endpoint is serving on (or connected to).

指定者:

getUri 在接口中 Endpoint<WebServer>

getPort

public int getPort()

从接口复制的说明: WebServer

Get base port that webserver is serving on.

指定者:

getPort 在接口中 WebServer

getExecutor

public Executor getExecutor()

从接口复制的说明: Endpoint

Get main work executor that all handlers will execute on.

指定者:

getExecutor 在接口中 Endpoint<WebServer>

staleConnectionTimeout

public NettyWebServer staleConnectionTimeout(long millis)

从接口复制的说明: WebServer

Number of milliseconds before a stale HTTP keep-alive connection is closed by the server. A HTTP connection is considered stale if it remains open without sending more data within the timeout window.

指定者:

staleConnectionTimeout 在接口中 WebServer

add

public NettyWebServer add(HttpHandler handler)

从接口复制的说明: WebServer

Add an HttpHandler. When a request comes in the first HttpHandler will be invoked. The HttpHandler should either handle the request, or pass the request onto the next HttpHandler (using HttpControl.nextHandler()). This is repeated until a HttpHandler returns a response. If there are no remaining handlers, the webserver shall return 404 NOT FOUND to the browser.

HttpHandlers are attempted in the order in which they are added to the WebServer.

指定者:

add 在接口中 WebServer

另请参阅:

HttpHandler

add

public NettyWebServer add(String path,
                 HttpHandler handler)

从接口复制的说明: WebServer

Add an HttpHandler that will only respond to a certain path (e.g "/some/page").

This is shortcut for add(newPathMatchHandler(path, handler)).

指定者:

add 在接口中 WebServer

另请参阅:

HttpHandler, WebServer.add(HttpHandler), PathMatchHandler

add

public NettyWebServer add(String path,
                 WebSocketHandler handler)

从接口复制的说明: WebServer

Add a WebSocketHandler for dealing with WebSockets.

This is shortcut for add(new PathMatchHandler(path, newHttpToWebSocketHandler(handler))).

指定者:

add 在接口中 WebServer

另请参阅:

WebSocketHandler, HttpHandler, WebServer.add(HttpHandler), HttpToWebSocketHandler, PathMatchHandler

add

public NettyWebServer add(String path,
                 EventSourceHandler handler)

从接口复制的说明: WebServer

Add a WebSocketHandler for dealing with WebSockets.

This is shortcut for add(new PathMatchHandler(path, newHttpToEventSourceHandler(handler))).

指定者:

add 在接口中 WebServer

另请参阅:

HttpHandler, WebServer.add(HttpHandler), HttpToEventSourceHandler, PathMatchHandler

start

public Future<NettyWebServer> start()

从接口复制的说明: Endpoint

Start in background. This returns immediately, but the endpoint may still not be ready to accept incoming requests (or have established a connection - if this is a client). To wait until it's fully started, call Future.get() on the returned future.

指定者:

start 在接口中 Endpoint<WebServer>

isRunning

public boolean isRunning()

stop

public Future<WebServer> stop()

从接口复制的说明: Endpoint

Stop in background. This returns immediately, but the endpoint may still be shutting down. To wait until it's fully stopped, call Future.get() on the returned future.

指定者:

stop 在接口中 Endpoint<WebServer>

shutdownAndAwaitTermination

private void shutdownAndAwaitTermination(ExecutorService executorService)

uncaughtExceptionHandler

public NettyWebServer uncaughtExceptionHandler(Thread.UncaughtExceptionHandler exceptionHandler)

从接口复制的说明: Endpoint

What to do when an exception gets thrown in a handler.

Defaults to using PrintStackTraceExceptionHandler. It is suggested that apps supply their own implementation (e.g. to log somewhere).

指定者:

uncaughtExceptionHandler 在接口中 Endpoint<WebServer>

connectionExceptionHandler

public NettyWebServer connectionExceptionHandler(Thread.UncaughtExceptionHandler ioExceptionHandler)

从接口复制的说明: Endpoint

What to do when an exception occurs when attempting to read/write data from/to the underlying connection. e.g. If an HTTP request disconnects before it was expected.

Defaults to using SilentExceptionHandler as this is a common thing to happen on a network, and most systems should not care.

指定者:

connectionExceptionHandler 在接口中 Endpoint<WebServer>

maxChunkSize

public NettyWebServer maxChunkSize(int maxChunkSize)

另请参阅:

HttpRequestDecoder

maxContentLength

public NettyWebServer maxContentLength(int maxContentLength)

另请参阅:

HttpChunkAggregator

maxHeaderSize

public NettyWebServer maxHeaderSize(int maxHeaderSize)

另请参阅:

HttpRequestDecoder

maxInitialLineLength

public NettyWebServer maxInitialLineLength(int maxInitialLineLength)

另请参阅:

HttpRequestDecoder

localUri

private static URI localUri(int port)

timestamp

protected long timestamp()

nextId

protected Object nextId()