Package io.helidon.webserver

Class SocketConfiguration.Builder

java.lang.Object

io.helidon.webserver.SocketConfiguration.Builder

All Implemented Interfaces:

Builder<SocketConfiguration>

Enclosing interface:

SocketConfiguration

public static final class SocketConfiguration.Builder
extends java.lang.Object
implements Builder<SocketConfiguration>

The SocketConfiguration builder class.

Method Summary

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(java.net.InetAddress bindAddress)	Configures local address where the server listens on with the server socket.
SocketConfiguration	build()	Build the instance from this builder.
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(Builder<? extends javax.net.ssl.SSLContext> sslContextBuilder)	Configures a SSLContext to use with the server socket.
SocketConfiguration.Builder	ssl(javax.net.ssl.SSLContext sslContext)	Configures a SSLContext to use with the server socket.
SocketConfiguration.Builder	timeoutMillis(int timeoutMillis)	Configures a server socket timeout in milliseconds or 0 for an infinite timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

port

public SocketConfiguration.Builder port(int port)

Configures a server port to listen on with the server socket. If port is 0 then any available ephemeral port will be used.

Parameters:

port - the server port of the server socket

Returns:

this builder

bindAddress

public SocketConfiguration.Builder bindAddress(java.net.InetAddress bindAddress)

Configures local address where the server listens on with the server socket. If null then listens an all local addresses.

Parameters:

bindAddress - an address to bind with the server socket; null for all local addresses

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.

Parameters:

backlog - a maximum length of the queue of incoming connections

Returns:

this builder

timeoutMillis

public SocketConfiguration.Builder timeoutMillis(int timeoutMillis)

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.

Parameters:

receiveBufferSize - a buffer size in bytes of the server socket or 0

Returns:

this builder

ssl

public SocketConfiguration.Builder ssl(javax.net.ssl.SSLContext sslContext)

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

public SocketConfiguration.Builder ssl(Builder<? extends javax.net.ssl.SSLContext> sslContextBuilder)

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

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