org.springframework.boot.web.embedded.netty

Class NettyWebServer

java.lang.Object

org.springframework.boot.web.embedded.netty.NettyWebServer

All Implemented Interfaces:

WebServer

public class NettyWebServer
extends Object
implements WebServer

WebServer that can be used to control a Reactor Netty web server. Usually this class should be created using the NettyReactiveWebServerFactory and not directly.

Since:

2.0.0

Author:

Brian Clozel, Madhura Bhave, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
NettyWebServer(reactor.netty.http.server.HttpServer httpServer, ReactorHttpHandlerAdapter handlerAdapter, Duration lifecycleTimeout)
NettyWebServer(reactor.netty.http.server.HttpServer httpServer, ReactorHttpHandlerAdapter handlerAdapter, Duration lifecycleTimeout, Duration shutdownGracePeriod) Creates a NettyWebServer.

Method Summary

Modifier and Type	Method and Description
int	getPort() Return the port this server is listening on.
void	setRouteProviders(List<NettyRouteProvider> routeProviders)
boolean	shutDownGracefully() Gracefully shuts down the web server by preventing the handling of new requests and waiting for a configurable period for there to be no active requests.
void	start() Starts the web server.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyWebServer

public NettyWebServer(reactor.netty.http.server.HttpServer httpServer,
                      ReactorHttpHandlerAdapter handlerAdapter,
                      Duration lifecycleTimeout)

NettyWebServer

public NettyWebServer(reactor.netty.http.server.HttpServer httpServer,
                      ReactorHttpHandlerAdapter handlerAdapter,
                      Duration lifecycleTimeout,
                      Duration shutdownGracePeriod)

Creates a NettyWebServer.

Parameters:

httpServer - the Reactor Netty HTTP server

handlerAdapter - the Spring WebFlux handler adapter

lifecycleTimeout - lifecycle timeout

shutdownGracePeriod - grace period for handler for graceful shutdown

Since:

2.3.0

Method Detail

setRouteProviders

public void setRouteProviders(List<NettyRouteProvider> routeProviders)

start

public void start()
           throws WebServerException

Description copied from interface: WebServer

Starts the web server. Calling this method on an already started server has no effect.

Specified by:

start in interface WebServer

Throws:

WebServerException - if the server cannot be started

shutDownGracefully

public boolean shutDownGracefully()

Description copied from interface: WebServer

Gracefully shuts down the web server by preventing the handling of new requests and waiting for a configurable period for there to be no active requests.

Specified by:

shutDownGracefully in interface WebServer

Returns:

true if graceful shutdown completed within the period, otherwise false

stop

public void stop()
          throws WebServerException

Description copied from interface: WebServer

Stops the web server. Calling this method on an already stopped server has no effect.

Specified by:

stop in interface WebServer

Throws:

WebServerException - if the server cannot be stopped

getPort

public int getPort()

Description copied from interface: WebServer

Return the port this server is listening on.

Specified by:

getPort in interface WebServer

Returns:

the port (or -1 if none)