java.lang.Object
- io.helidon.webserver.SocketConfiguration.Builder

All Implemented Interfaces:

Builder<SocketConfiguration>, SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>, Supplier<SocketConfiguration>

Enclosing interface:

SocketConfiguration
```
public static final class SocketConfiguration.Builder
extends Object
implements SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>, Builder<SocketConfiguration>
```
The SocketConfiguration builder class.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`SocketConfiguration.Builder`	`backlog(int backlog)`	Configures a maximum length of the queue of incoming connections on the server socket.
`SocketConfiguration.Builder`	`bindAddress(InetAddress bindAddress)`	Configures local address where the server listens on with the server socket.
`SocketConfiguration`	`build()`	Build the instance from this builder.
`SocketConfiguration.Builder`	`config(Config config)`	Update this socket configuration from a `Config`.
`boolean`	`enabled()`
`SocketConfiguration.Builder`	`enabled(boolean enabled)`	Set this socket builder to enabled or disabled.
`SocketConfiguration.Builder`	`enabledSSlProtocols(String... protocols)`	Deprecated. since 2.0.0, please use `WebServerTls.Builder.enabledProtocols(String...)` instead
`SocketConfiguration.Builder`	`enabledSSlProtocols(List<String> protocols)`	Deprecated.
`SocketConfiguration.Builder`	`name(String name)`	Configure a socket name, to bind named routings to.
`SocketConfiguration.Builder`	`port(int port)`	Configures a server port to listen on with the server socket.
`SocketConfiguration.Builder`	`receiveBufferSize(int receiveBufferSize)`	Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
`SocketConfiguration.Builder`	`ssl(Supplier<? extends SSLContext> sslContextBuilder)`	Deprecated. since 2.0.0, please use `SocketConfiguration.SocketConfigurationBuilder.tls(Supplier)` instead
`SocketConfiguration.Builder`	`ssl(SSLContext sslContext)`	Deprecated. since 2.0.0, please use `tls(WebServerTls)` instead
`SocketConfiguration.Builder`	`timeout(long amount, TimeUnit unit)`	Configures a server socket timeout.
`SocketConfiguration.Builder`	`timeoutMillis(int timeoutMillis)`	Deprecated. since 2.0.0 please use `timeout(long, java.util.concurrent.TimeUnit)` instead
`SocketConfiguration.Builder`	`tls(WebServerTls webServerTls)`	Configures SSL for this socket.

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

Methods inherited from interface io.helidon.common.Builder
get

Methods inherited from interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
bindAddress, host, tls

- Method Detail
  - build
```
public SocketConfiguration build()
```
    Description copied from interface: Builder
    
    Build the instance from this builder.
    
    Specified by:
    
    build in interface Builder<SocketConfiguration>
    
    Returns:
    
    instance of the built type
  - port
```
public SocketConfiguration.Builder port(int port)
```
    Description copied from interface: SocketConfiguration.SocketConfigurationBuilder
    
    Configures a server port to listen on with the server socket. If port is 0 then any available ephemeral port will be used.
    
    Specified by:
    
    port in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    port - the server port of the server socket
    
    Returns:
    
    this builder
  - bindAddress
```
public SocketConfiguration.Builder bindAddress(InetAddress bindAddress)
```
    Description copied from interface: SocketConfiguration.SocketConfigurationBuilder
    
    Configures local address where the server listens on with the server socket. If not configured, then listens an all local addresses.
    
    Specified by:
    
    bindAddress in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    bindAddress - an address to bind with the server socket
    
    Returns:
    
    this builder
  - backlog
```
public SocketConfiguration.Builder backlog(int backlog)
```
    Configures a maximum length of the queue of incoming connections on the server socket.
    Default value is SocketConfiguration.DEFAULT_BACKLOG_SIZE.
    
    Specified by:
    
    backlog in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    backlog - a maximum length of the queue of incoming connections
    
    Returns:
    
    this builder
  - timeoutMillis
```
@Deprecated
public SocketConfiguration.Builder timeoutMillis(int timeoutMillis)
```
    Deprecated.
    since 2.0.0 please use timeout(long, java.util.concurrent.TimeUnit) instead
    
    Configures a server socket timeout in milliseconds or 0 for an infinite timeout.
    
    Parameters:
    
    timeoutMillis - a server socket timeout in milliseconds or 0
    
    Returns:
    
    this builder
  - receiveBufferSize
```
public SocketConfiguration.Builder receiveBufferSize(int receiveBufferSize)
```
    Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
    If 0 then use implementation default.
    
    Specified by:
    
    receiveBufferSize in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    receiveBufferSize - a buffer size in bytes of the server socket or 0
    
    Returns:
    
    this builder
  - ssl
```
@Deprecated
public SocketConfiguration.Builder ssl(SSLContext sslContext)
```
    Deprecated.
    since 2.0.0, please use tls(WebServerTls) instead
    
    Configures a SSLContext to use with the server socket. If not null then the server enforces an SSL communication.
    
    Parameters:
    
    sslContext - a SSL context to use
    
    Returns:
    
    this builder
  - ssl
```
@Deprecated
public SocketConfiguration.Builder ssl(Supplier<? extends SSLContext> sslContextBuilder)
```
    Deprecated.
    since 2.0.0, please use SocketConfiguration.SocketConfigurationBuilder.tls(Supplier) instead
    
    Configures a SSLContext to use with the server socket. If not null then the server enforces an SSL communication.
    
    Parameters:
    
    sslContextBuilder - a SSL context builder to use; will be built as a first step of this method execution
    
    Returns:
    
    this builder
  - enabledSSlProtocols
```
@Deprecated
public SocketConfiguration.Builder enabledSSlProtocols(String... protocols)
```
    Deprecated.
    since 2.0.0, please use WebServerTls.Builder.enabledProtocols(String...) instead
    
    Configures the SSL protocols to enable with the server socket.
    
    Parameters:
    
    protocols - protocols to enable, if null enables the default protocols
    
    Returns:
    
    this builder
  - enabledSSlProtocols
```
@Deprecated
public SocketConfiguration.Builder enabledSSlProtocols(List<String> protocols)
```
    Deprecated.
    
    Configures the SSL protocols to enable with the server socket.
    
    Parameters:
    
    protocols - protocols to enable, if null or empty enables the default protocols
    
    Returns:
    
    this builder
  - timeout
```
public SocketConfiguration.Builder timeout(long amount,
                                           TimeUnit unit)
```
    Description copied from interface: SocketConfiguration.SocketConfigurationBuilder
    
    Configures a server socket timeout.
    
    Specified by:
    
    timeout in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    amount - an amount of time to configure the timeout, use 0 for infinite timeout
    
    unit - time unit to use with the configured amount
    
    Returns:
    
    this builder
  - tls
```
public SocketConfiguration.Builder tls(WebServerTls webServerTls)
```
    Description copied from interface: SocketConfiguration.SocketConfigurationBuilder
    
    Configures SSL for this socket. When configured, the server enforces SSL configuration. If this method is called, any other method except for SocketConfiguration.SocketConfigurationBuilder.tls(java.util.function.Supplier)¨ and repeated invocation of this method would be ignored.
    If this method is called again, the previous configuration would be ignored.
    
    Specified by:
    
    tls in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    webServerTls - ssl configuration to use with this socket
    
    Returns:
    
    this builder
  - name
```
public SocketConfiguration.Builder name(String name)
```
    Configure a socket name, to bind named routings to.
    
    Parameters:
    
    name - name of the socket
    
    Returns:
    
    updated builder instance
  - enabled
```
public SocketConfiguration.Builder enabled(boolean enabled)
```
    Set this socket builder to enabled or disabled.
    
    Parameters:
    
    enabled - when set to false, the socket is not going to be opened by the server
    
    Returns:
    
    updated builder instance
  - config
```
public SocketConfiguration.Builder config(Config config)
```
    Description copied from interface: SocketConfiguration.SocketConfigurationBuilder
    
    Update this socket configuration from a Config.
    
    Specified by:
    
    config in interface SocketConfiguration.SocketConfigurationBuilder<SocketConfiguration.Builder>
    
    Parameters:
    
    config - configuration on the node of a socket
    
    Returns:
    
    updated builder instance
  - enabled
```
public boolean enabled()
```

Class SocketConfiguration.Builder

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.helidon.common.Builder

Methods inherited from interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder

Method Detail

build

port

bindAddress

backlog

timeoutMillis

receiveBufferSize

ssl

ssl

enabledSSlProtocols

enabledSSlProtocols

timeout

tls

name

enabled

config

enabled