ServerConfig (Armeria 0.59.0 API reference)

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

public final class ServerConfig
extends Object

Server configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Consumer<RequestLog>`	`accessLogWriter()` Returns an access log writer.
`ExecutorService`	`blockingTaskExecutor()` Returns the `ExecutorService` dedicated to the execution of blocking tasks or invocations.
`int`	`defaultMaxHttp1ChunkSize()` Returns the default maximum length of each chunk in an HTTP/1 response content.
`int`	`defaultMaxHttp1HeaderSize()` Returns the default maximum length of all headers in an HTTP/1 response.
`int`	`defaultMaxHttp1InitialLineLength()` Returns the default maximum length of an HTTP/1 response initial line.
`long`	`defaultMaxRequestLength()` Returns the default maximum allowed length of the content decoded at the session layer.
`long`	`defaultRequestTimeoutMillis()` Returns the default timeout of a request.
`VirtualHost`	`defaultVirtualHost()` Returns the default `VirtualHost`, which is used when no other `VirtualHost`s match the host name of a client request. e.g. the `"Host"` header in HTTP or host name in TLS SNI extension
`VirtualHost`	`findVirtualHost(String hostname)` Finds the `VirtualHost` that matches the specified `hostname`.
`List<VirtualHost>`	`findVirtualHosts(Service<?,?> service)` Finds the `List` of `VirtualHost`s that contains the specified `Service`.
`Duration`	`gracefulShutdownQuietPeriod()` Returns the number of milliseconds to wait for active requests to go end before shutting down.
`Duration`	`gracefulShutdownTimeout()` Returns the number of milliseconds to wait before shutting down the server regardless of active requests.
`long`	`idleTimeoutMillis()` Returns the idle timeout of a connection in milliseconds for keep-alive.
`int`	`maxNumConnections()` Returns the maximum allowed number of open connections.
`io.micrometer.core.instrument.MeterRegistry`	`meterRegistry()` Returns the `MeterRegistry` that collects various stats.
`List<ServerPort>`	`ports()` Returns the `ServerPort`s to listen on.
`Server`	`server()` Returns the `Server`.
`List<ServiceConfig>`	`serviceConfigs()` Returns the information of all available `Service`s in the `Server`.
`String`	`serviceLoggerPrefix()` Returns the prefix of service logger's names.
`boolean`	`shutdownWorkerGroupOnStop()` Returns whether the worker `EventLoopGroup` is shut down when the `Server` stops.
`String`	`toString()`
`List<VirtualHost>`	`virtualHosts()` Returns the `List` of available `VirtualHost`s.
`EventLoopGroup`	`workerGroup()` Returns the worker `EventLoopGroup` which is responsible for performing socket I/O and running `Service.serve(ServiceRequestContext, Request)`.

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

- Method Detail
  - server
```
public Server server()
```
    Returns the Server.
  - ports
```
public List<ServerPort> ports()
```
    Returns the ServerPorts to listen on.
    
    See Also:
    
    Server.activePorts()
  - defaultVirtualHost
```
public VirtualHost defaultVirtualHost()
```
    Returns the default VirtualHost, which is used when no other VirtualHosts match the host name of a client request. e.g. the "Host" header in HTTP or host name in TLS SNI extension
    
    See Also:
    
    virtualHosts()
  - virtualHosts
```
public List<VirtualHost> virtualHosts()
```
    Returns the List of available VirtualHosts.
    
    Returns:
    
    the List of available VirtualHosts where its last VirtualHost is defaultVirtualHost()
  - findVirtualHost
```
public VirtualHost findVirtualHost(String hostname)
```
    Finds the VirtualHost that matches the specified hostname. If there's no match, the defaultVirtualHost() is returned.
  - findVirtualHosts
```
public List<VirtualHost> findVirtualHosts(Service<?,?> service)
```
    Finds the List of VirtualHosts that contains the specified Service. If there's no match, an empty List is returned. Note that this is potentially an expensive operation and thus should not be used in a performance-sensitive path.
  - serviceConfigs
```
public List<ServiceConfig> serviceConfigs()
```
    Returns the information of all available Services in the Server.
  - workerGroup
```
public EventLoopGroup workerGroup()
```
    Returns the worker EventLoopGroup which is responsible for performing socket I/O and running Service.serve(ServiceRequestContext, Request).
  - shutdownWorkerGroupOnStop
```
public boolean shutdownWorkerGroupOnStop()
```
    Returns whether the worker EventLoopGroup is shut down when the Server stops.
  - maxNumConnections
```
public int maxNumConnections()
```
    Returns the maximum allowed number of open connections.
  - idleTimeoutMillis
```
public long idleTimeoutMillis()
```
    Returns the idle timeout of a connection in milliseconds for keep-alive.
  - defaultRequestTimeoutMillis
```
public long defaultRequestTimeoutMillis()
```
    Returns the default timeout of a request.
  - defaultMaxRequestLength
```
public long defaultMaxRequestLength()
```
    Returns the default maximum allowed length of the content decoded at the session layer. e.g. the content length of an HTTP request.
  - defaultMaxHttp1InitialLineLength
```
public int defaultMaxHttp1InitialLineLength()
```
    Returns the default maximum length of an HTTP/1 response initial line.
  - defaultMaxHttp1HeaderSize
```
public int defaultMaxHttp1HeaderSize()
```
    Returns the default maximum length of all headers in an HTTP/1 response.
  - defaultMaxHttp1ChunkSize
```
public int defaultMaxHttp1ChunkSize()
```
    Returns the default maximum length of each chunk in an HTTP/1 response content. The content or a chunk longer than this value will be split into smaller chunks so that their lengths never exceed it.
  - gracefulShutdownQuietPeriod
```
public Duration gracefulShutdownQuietPeriod()
```
    Returns the number of milliseconds to wait for active requests to go end before shutting down. 0 means the server will stop right away without waiting.
  - gracefulShutdownTimeout
```
public Duration gracefulShutdownTimeout()
```
    Returns the number of milliseconds to wait before shutting down the server regardless of active requests.
  - blockingTaskExecutor
```
public ExecutorService blockingTaskExecutor()
```
    Returns the ExecutorService dedicated to the execution of blocking tasks or invocations. Note that the ExecutorService returned by this method does not set the ServiceRequestContext when executing a submitted task. Use ServiceRequestContext.blockingTaskExecutor() if possible.
  - meterRegistry
```
public io.micrometer.core.instrument.MeterRegistry meterRegistry()
```
    Returns the MeterRegistry that collects various stats.
  - serviceLoggerPrefix
```
public String serviceLoggerPrefix()
```
    Returns the prefix of service logger's names.
  - accessLogWriter
```
public Consumer<RequestLog> accessLogWriter()
```
    Returns an access log writer.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ServerConfig

Method Summary

Methods inherited from class java.lang.Object

Method Detail

server

ports

defaultVirtualHost

virtualHosts

findVirtualHost

findVirtualHosts

serviceConfigs

workerGroup

shutdownWorkerGroupOnStop

maxNumConnections

idleTimeoutMillis

defaultRequestTimeoutMillis

defaultMaxRequestLength

defaultMaxHttp1InitialLineLength

defaultMaxHttp1HeaderSize

defaultMaxHttp1ChunkSize

gracefulShutdownQuietPeriod

gracefulShutdownTimeout

blockingTaskExecutor

meterRegistry

serviceLoggerPrefix

accessLogWriter

toString