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 java.lang.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

Constructor Summary

Constructors

Constructor and Description
NettyWebServer(reactor.netty.http.server.HttpServer httpServer, org.springframework.http.server.reactive.ReactorHttpHandlerAdapter handlerAdapter, java.time.Duration lifecycleTimeout)

Method Summary

Modifier and Type	Method and Description
int	getPort() Return the port this server is listening on.
void	setRouteProviders(java.util.List<NettyRouteProvider> routeProviders)
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,
                      org.springframework.http.server.reactive.ReactorHttpHandlerAdapter handlerAdapter,
                      java.time.Duration lifecycleTimeout)

Method Detail

setRouteProviders

public void setRouteProviders(java.util.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

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)