ServerConfiguration (Helidon 1.0.1 API)

All Superinterfaces:

SocketConfiguration
```
public interface ServerConfiguration
extends SocketConfiguration
```
Immutable WebServer configuration.
Use builder() to compose new instance.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ServerConfiguration.Builder
A ServerConfiguration builder.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ServerConfiguration.Builder` A `ServerConfiguration` builder.

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_SOCKET_NAME
The default server socket configuration name.
- Fields inherited from interface io.helidon.webserver.SocketConfiguration
  DEFAULT, DEFAULT_BACKLOG_SIZE

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SOCKET_NAME` The default server socket configuration name.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`int`	`backlog()` Returns a maximum length of the queue of incoming connections on the default server socket.
`InetAddress`	`bindAddress()` Returns local address where the server listens on with the default server socket.
`static ServerConfiguration.Builder`	`builder()` Creates new instance of a `server configuration builder`.
`static ServerConfiguration.Builder`	`builder(Config config)` Creates new instance of a `server configuration builder` with defaults from external configuration source.
`static ServerConfiguration`	`create(Config config)` Creates new instance with defaults from external configuration source.
`ExperimentalConfiguration`	`experimental()` Returns an `ExperimentalConfiguration`.
`int`	`port()` Returns a server port to listen on with the default server socket.
`int`	`receiveBufferSize()` Returns proposed value of the TCP receive window that is advertised to the remote peer on the default server socket.
`default SocketConfiguration`	`socket(String name)` A socket configuration of an additional named server socket.
`Map<String,SocketConfiguration>`	`sockets()` A map of all the configured server sockets; that is the default server socket which is identified by the key `DEFAULT_SOCKET_NAME` and also all the additional named server socket configurations.
`SSLContext`	`ssl()` Returns a `SSLContext` to use with the default server socket.
`int`	`timeoutMillis()` Returns a default server socket timeout in milliseconds or `0` for an infinite timeout.
`Tracer`	`tracer()` Returns an opentracing.io tracer.
`int`	`workersCount()` Returns a count of threads in s pool used to tryProcess HTTP requests.

- Field Detail
  - DEFAULT_SOCKET_NAME
```
static final String DEFAULT_SOCKET_NAME
```
    The default server socket configuration name. All the default server socket configuration (e.g., port() or backlog()) is accessible through socket(String) or sockets() with this default socket name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - workersCount
```
int workersCount()
```
    Returns a count of threads in s pool used to tryProcess HTTP requests.
    Default value is CPU_COUNT * 2.
    
    Returns:
    
    a workers count
  - port
```
int port()
```
    Returns a server port to listen on with the default server socket. If port is 0 then any available ephemeral port will be used.
    Additional named server socket configuration is accessible through the socket(String) and sockets() methods.
    
    Specified by:
    
    port in interface SocketConfiguration
    
    Returns:
    
    the server port of the default server socket
  - bindAddress
```
InetAddress bindAddress()
```
    Returns local address where the server listens on with the default server socket. If null then listens an all local addresses.
    Additional named server socket configuration is accessible through the socket(String) and sockets() methods.
    
    Specified by:
    
    bindAddress in interface SocketConfiguration
    
    Returns:
    
    an address to bind with the default server socket; null for all local addresses
  - backlog
```
int backlog()
```
    Returns a maximum length of the queue of incoming connections on the default server socket.
    Default value is SocketConfiguration.DEFAULT_BACKLOG_SIZE.
    Additional named server socket configuration is accessible through the socket(String) and sockets() methods.
    
    Specified by:
    
    backlog in interface SocketConfiguration
    
    Returns:
    
    a maximum length of the queue of incoming connections
  - timeoutMillis
```
int timeoutMillis()
```
    Returns a default server socket timeout in milliseconds or 0 for an infinite timeout.
    Additional named server socket configuration is accessible through the socket(String) and sockets() methods.
    
    Specified by:
    
    timeoutMillis in interface SocketConfiguration
    
    Returns:
    
    a default server socket timeout in milliseconds or 0
  - receiveBufferSize
```
int receiveBufferSize()
```
    Returns proposed value of the TCP receive window that is advertised to the remote peer on the default server socket.
    If 0 then use implementation default.
    Additional named server socket configuration is accessible through the socket(String) and sockets() methods.
    
    Specified by:
    
    receiveBufferSize in interface SocketConfiguration
    
    Returns:
    
    a buffer size in bytes of the default server socket or 0
  - ssl
```
SSLContext ssl()
```
    Returns a SSLContext to use with the default server socket. If not null then the server enforces an SSL communication.
    Additional named server socket configuration is accessible through the socket(String) and sockets() methods.
    
    Specified by:
    
    ssl in interface SocketConfiguration
    
    Returns:
    
    a SSL context to use
  - socket
```
default SocketConfiguration socket(String name)
```
    A socket configuration of an additional named server socket.
    An additional named server socket may have a dedicated Routing configured through WebServer.Builder.addNamedRouting(String, Routing).
    
    Parameters:
    
    name - the name of the additional server socket
    
    Returns:
    
    an additional named server socket configuration or null if there is no such named server socket
  - sockets
```
Map<String,SocketConfiguration> sockets()
```
    A map of all the configured server sockets; that is the default server socket which is identified by the key DEFAULT_SOCKET_NAME and also all the additional named server socket configurations.
    An additional named server socket may have a dedicated Routing configured through WebServer.Builder.addNamedRouting(String, Routing).
    
    Returns:
    
    a map of all the configured server sockets
  - tracer
```
Tracer tracer()
```
    Returns an opentracing.io tracer. Default is GlobalTracer.
    
    Returns:
    
    a tracer to use - never null (defaulting to GlobalTracer
  - experimental
```
ExperimentalConfiguration experimental()
```
    Returns an ExperimentalConfiguration.
    
    Returns:
    
    Experimental configuration.
  - create
```
static ServerConfiguration create(Config config)
```
    Creates new instance with defaults from external configuration source.
    
    Parameters:
    
    config - the externalized configuration
    
    Returns:
    
    a new instance
  - builder
```
static ServerConfiguration.Builder builder()
```
    Creates new instance of a server configuration builder.
    
    Specified by:
    
    builder in interface SocketConfiguration
    
    Returns:
    
    a new builder instance
  - builder
```
static ServerConfiguration.Builder builder(Config config)
```
    Creates new instance of a server configuration builder with defaults from external configuration source.
    
    Parameters:
    
    config - the externalized configuration
    
    Returns:
    
    a new builder instance

Interface ServerConfiguration

Nested Class Summary

Field Summary

Fields inherited from interface io.helidon.webserver.SocketConfiguration

Method Summary

Field Detail

DEFAULT_SOCKET_NAME

Method Detail

workersCount

port

bindAddress

backlog

timeoutMillis

receiveBufferSize

ssl

socket

sockets

tracer

experimental

create

builder

builder