Server (Armeria 0.55.0 API reference)

java.lang.Object
- com.linecorp.armeria.server.Server

All Implemented Interfaces:

AutoCloseable
```
public final class Server
extends Object
implements AutoCloseable
```
Listens to ServerPorts and delegates client requests to Services.

See Also:

ServerBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<ServerPort>`	`activePort()` Returns the primary `ServerPort` that this `Server` is listening to.
`Map<InetSocketAddress,ServerPort>`	`activePorts()` Returns all `ServerPort`s 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`	`close()` A shortcut to `stop().get()`.
`ServerConfig`	`config()` Returns the configuration of this `Server`.
`String`	`defaultHostname()` Returns the hostname of the default `VirtualHost`, which is the hostname of the machine unless configured explicitly via `ServerBuilder.defaultVirtualHost(VirtualHost)`.
`MeterRegistry`	`meterRegistry()` Returns the `MeterRegistry` that collects various stats.
`EventLoop`	`nextEventLoop()` Returns a `EventLoop` from the worker group.
`int`	`numConnections()` Returns the number of open connections on this `Server`.
`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.
`CompletableFuture<Void>`	`start()` Starts this `Server` to listen to the `ServerPort`s specified in the `ServerConfig`.
`CompletableFuture<Void>`	`stop()` Stops this `Server` to close all active `ServerPort`s.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - config
```
public ServerConfig config()
```
    Returns the configuration of this Server.
  - defaultHostname
```
public String defaultHostname()
```
    Returns the hostname of the default VirtualHost, which is the hostname of the machine unless configured explicitly via ServerBuilder.defaultVirtualHost(VirtualHost).
  - 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
```
public Optional<ServerPort> activePort()
```
    Returns the primary ServerPort that this Server is listening to. This method is useful when a Server listens to only one ServerPort.
    
    Returns:
    
    Optional.empty() if this Server did not start
  - meterRegistry
```
public 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 = new ServerBuilder();
 ...
 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 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.
  - close
```
public void close()
```
    A shortcut to stop().get().
    
    Specified by:
    
    close in interface AutoCloseable
  - numConnections
```
public int numConnections()
```
    Returns the number of open connections on this Server.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Server

Method Summary

Methods inherited from class java.lang.Object

Method Detail

config

defaultHostname

activePorts

activePort

meterRegistry

addListener

removeListener

start

stop

nextEventLoop

close

numConnections

toString