Package com.linecorp.armeria.server

Class Server

java.lang.Object

com.linecorp.armeria.server.Server

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, AutoCloseable

public final class Server
extends Object
implements ListenableAsyncCloseable

Listens to ServerPorts and delegates client requests to Services.

See Also:

• ServerBuilder

Method Summary

Modifier and Type	Method	Description
int	activeLocalPort()	Returns the local ServerPort that this Server is listening to.
int	activeLocalPort(SessionProtocol protocol)	Returns the local ServerPort which serves the given SessionProtocol.
@Nullable ServerPort	activePort()	Returns the primary ServerPort that this Server is listening to.
@Nullable ServerPort	activePort(SessionProtocol protocol)	Returns the primary ServerPort which serves the given SessionProtocol that this Server is listening to.
Map<InetSocketAddress,ServerPort>	activePorts()	Returns all ServerPorts that this Server is listening to.
void	addListener(ServerListener listener)	Adds the specified ServerListener to this Server, so that it is notified when the state of this Server changes.
void	blockUntilShutdown()	Waits until the result of CompletableFuture which is completed after the close() or closeAsync() operation is completed.
static ServerBuilder	builder()	Creates a new ServerBuilder.
void	close()	Releases any underlying resources held by this object synchronously.
CompletableFuture<?>	closeAsync()	Releases any underlying resources held by this object asynchronously.
CompletableFuture<Void>	closeOnJvmShutdown()	Registers a JVM shutdown hook that closes this Server when the current JVM terminates.
CompletableFuture<Void>	closeOnJvmShutdown(Runnable whenClosing)	Registers a JVM shutdown hook that closes this Server when the current JVM terminates.
ServerConfig	config()	Returns the configuration of this Server.
String	defaultHostname()	Returns the hostname of the default VirtualHost, which is the hostname of the machine.
boolean	isClosed()	Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.
boolean	isClosing()	Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.
io.micrometer.core.instrument.MeterRegistry	meterRegistry()	Returns the MeterRegistry that collects various stats.
io.netty.channel.EventLoop	nextEventLoop()	Returns a EventLoop from the worker group.
int	numConnections()	Returns the number of open connections on this Server.
void	reconfigure(ServerConfigurator serverConfigurator)	Reconfigure Server configuration.
boolean	removeListener(ServerListener listener)	Removes the specified ServerListener from this Server, so that it is not notified anymore when the state of this Server changes.
List<ServiceConfig>	serviceConfigs()	Returns the information of all available Services in the Server.
CompletableFuture<Void>	start()	Starts this Server to listen to the ServerPorts specified in the ServerConfig.
CompletableFuture<Void>	stop()	Stops this Server to close all active ServerPorts.
String	toString()
CompletableFuture<?>	whenClosed()	Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ServerBuilder builder()

Creates a new ServerBuilder.

config

public ServerConfig config()

Returns the configuration of this Server.

serviceConfigs

public List<ServiceConfig> serviceConfigs()

Returns the information of all available Services in the Server.

defaultHostname

public String defaultHostname()

Returns the hostname of the default VirtualHost, which is the hostname of the machine.

activePorts

public Map<InetSocketAddress,ServerPort> activePorts()

Returns all ServerPorts that this Server is listening to.

Returns:

a Map whose key is the bind address and value is ServerPort. an empty Map if this Server did not start.

See Also:

• activePort()

activePort

@Nullable
public @Nullable ServerPort activePort()

Returns the primary ServerPort that this Server is listening to. If this Server has both a local port and a non-local port, the non-local port is returned.

Returns:

the primary ServerPort, or null if this Server did not start.

activePort

@Nullable
public @Nullable ServerPort activePort(SessionProtocol protocol)

Returns the primary ServerPort which serves the given SessionProtocol that this Server is listening to. If this Server has both a local port and a non-local port, the non-local port is returned.

Returns:

the primary ServerPort, or null if there is no active port available for the given SessionProtocol.

activeLocalPort

public int activeLocalPort()

Returns the local ServerPort that this Server is listening to.

Throws:

IllegalStateException - if there is no active local port available or the server is not started yet

activeLocalPort

public int activeLocalPort(SessionProtocol protocol)

Returns the local ServerPort which serves the given SessionProtocol.

Throws:

IllegalStateException - if there is no active local port available for the given SessionProtocol or the server is not started yet

meterRegistry

public io.micrometer.core.instrument.MeterRegistry meterRegistry()

Returns the MeterRegistry that collects various stats.

addListener

public void addListener(ServerListener listener)

Adds the specified ServerListener to this Server, so that it is notified when the state of this Server changes. This method is useful when you want to initialize/destroy the resources associated with a Service:

 > public class MyService extends SimpleService {
 >     @Override
 >     public void serviceAdded(Server server) {
 >         server.addListener(new ServerListenerAdapter() {
 >             @Override
 >             public void serverStarting() {
 >                 ... initialize ...
 >             }
 >
 >             @Override
 >             public void serverStopped() {
 >                 ... destroy ...
 >             }
 >         }
 >     }
 > }
 

removeListener

public boolean removeListener(ServerListener listener)

Removes the specified ServerListener from this Server, so that it is not notified anymore when the state of this Server changes.

start

public CompletableFuture<Void> start()

Starts this Server to listen to the ServerPorts specified in the ServerConfig. Note that the startup procedure is asynchronous and thus this method returns immediately. To wait until this Server is fully started up, wait for the returned CompletableFuture:

 ServerBuilder builder = Server.builder();
 ...
 Server server = builder.build();
 server.start().get();
 

stop

public CompletableFuture<Void> stop()

Stops this Server to close all active ServerPorts. Note that the shutdown procedure is asynchronous and thus this method returns immediately. To wait until this Server is fully shut down, wait for the returned CompletableFuture:

 Server server = ...;
 server.stop().get();
 

nextEventLoop

public io.netty.channel.EventLoop nextEventLoop()

Returns a EventLoop from the worker group. This can be used for, e.g., scheduling background tasks for the lifetime of the Server using EventExecutorGroup.scheduleAtFixedRate(Runnable, long, long, TimeUnit). It is very important that these tasks do not block as this would block all requests in the server on that EventLoop.

isClosing

public boolean isClosing()

Description copied from interface: ListenableAsyncCloseable

Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.

Specified by:

isClosing in interface ListenableAsyncCloseable

See Also:

• ListenableAsyncCloseable.isClosed()

isClosed

public boolean isClosed()

Description copied from interface: ListenableAsyncCloseable

Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.

Specified by:

isClosed in interface ListenableAsyncCloseable

See Also:

• ListenableAsyncCloseable.isClosing()

whenClosed

public CompletableFuture<?> whenClosed()

Description copied from interface: ListenableAsyncCloseable

Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.

Specified by:

whenClosed in interface ListenableAsyncCloseable

closeAsync

public CompletableFuture<?> closeAsync()

Description copied from interface: AsyncCloseable

Releases any underlying resources held by this object asynchronously.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

the CompletableFuture which is completed after the resources are released

close

public void close()

Description copied from interface: AsyncCloseable

Releases any underlying resources held by this object synchronously.

Specified by:

close in interface AsyncCloseable

Specified by:

close in interface AutoCloseable

numConnections

public int numConnections()

Returns the number of open connections on this Server.

blockUntilShutdown

public void blockUntilShutdown()
                        throws InterruptedException

Waits until the result of CompletableFuture which is completed after the close() or closeAsync() operation is completed.

Throws:

InterruptedException

toString

public String toString()

Overrides:

toString in class Object

reconfigure

public void reconfigure(ServerConfigurator serverConfigurator)

Reconfigure Server configuration. This feature is only available once a server is configured and started. We do not allow ports to be reconfigured.

closeOnJvmShutdown

public CompletableFuture<Void> closeOnJvmShutdown()

Registers a JVM shutdown hook that closes this Server when the current JVM terminates.

closeOnJvmShutdown

public CompletableFuture<Void> closeOnJvmShutdown(Runnable whenClosing)

Registers a JVM shutdown hook that closes this Server when the current JVM terminates.

Parameters:

whenClosing - the Runnable will be run before closing this Server