SocketConfiguration (Helidon 1.0.0 API)

All Known Subinterfaces:

ServerConfiguration
```
public interface SocketConfiguration
```
The SocketConfiguration configures a port to listen on and its associated server socket parameters.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class SocketConfiguration.Builder
The SocketConfiguration builder class.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SocketConfiguration.Builder` The `SocketConfiguration` builder class.

Field Summary

Fields
Modifier and Type	Field and Description
`static SocketConfiguration`	`DEFAULT` The default socket configuration.
`static int`	`DEFAULT_BACKLOG_SIZE` The default backlog size to configure the server sockets with if no other value is provided.

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 server socket.
`InetAddress`	`bindAddress()` Returns local address where the server listens on with the server socket.
`static SocketConfiguration.Builder`	`builder()` Creates a builder of `SocketConfiguration` class.
`int`	`port()` Returns a server port to listen on with the server socket.
`int`	`receiveBufferSize()` Returns proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
`SSLContext`	`ssl()` Returns a `SSLContext` to use with the server socket.
`int`	`timeoutMillis()` Returns a server socket timeout in milliseconds or `0` for an infinite timeout.

- Field Detail
  - DEFAULT
```
static final SocketConfiguration DEFAULT
```
    The default socket configuration.
  - DEFAULT_BACKLOG_SIZE
```
static final int DEFAULT_BACKLOG_SIZE
```
    The default backlog size to configure the server sockets with if no other value is provided.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - port
```
int port()
```
    Returns a server port to listen on with the server socket. If port is 0 then any available ephemeral port will be used.
    
    Returns:
    
    the server port of the server socket
  - bindAddress
```
InetAddress bindAddress()
```
    Returns local address where the server listens on with the server socket. If null then listens an all local addresses.
    
    Returns:
    
    an address to bind with the server socket; null for all local addresses
  - backlog
```
int backlog()
```
    Returns a maximum length of the queue of incoming connections on the server socket.
    Default value is DEFAULT_BACKLOG_SIZE.
    
    Returns:
    
    a maximum length of the queue of incoming connections
  - timeoutMillis
```
int timeoutMillis()
```
    Returns a server socket timeout in milliseconds or 0 for an infinite timeout.
    
    Returns:
    
    a 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 server socket.
    If 0 then use implementation default.
    
    Returns:
    
    a buffer size in bytes of the server socket or 0
  - ssl
```
SSLContext ssl()
```
    Returns a SSLContext to use with the server socket. If not null then the server enforces an SSL communication.
    
    Returns:
    
    a SSL context to use
  - builder
```
static SocketConfiguration.Builder builder()
```
    Creates a builder of SocketConfiguration class.
    
    Returns:
    
    a builder

Interface SocketConfiguration

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT

DEFAULT_BACKLOG_SIZE

Method Detail

port

bindAddress

backlog

timeoutMillis

receiveBufferSize

ssl

builder