SocketConfigurationBuilder (webserver.SocketConfiguration) Configuration

SocketConfigurationBuilder (webserver.SocketConfiguration) Configuration: Type: io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder

Configuration options

Optional configuration options

key	type	default value	description
`backlog`	int	`1024`	Configures a maximum length of the queue of incoming connections on the server socket. Default value is #DEFAULT_BACKLOG_SIZE.
`backpressure-buffer-size`	long		Maximum length of the response data sending buffer can keep without flushing. Depends on `backpressure-policy` what happens if max buffer size is reached.
`backpressure-strategy`	BackpressureStrategy (LINEAR, AUTO_FLUSH, PREFETCH, UNBOUNDED)	`LINEAR`	Sets a backpressure strategy for the server to apply against user provided response upstream. LINEAR - Data are requested one-by-one, in case buffer reaches watermark, no other data is requested. AUTO_FLUSH - Data are requested one-by-one, in case buffer reaches watermark, no other data is requested. PREFETCH - After first data chunk arrives, probable number of chunks needed to fill the buffer up to watermark is calculated and requested. NONE - No backpressure is applied, Long.MAX_VALUE(unbounded) is requested from upstream.
~~`bind-address`~~	string		Deprecated Configures local address where the server listens on with the server socket. If not configured, then listens an all local addresses.
`enable-compression`	boolean	`false`	Enable negotiation for gzip/deflate content encodings. Clients can request compression using the "Accept-Encoding" header. Default is `false`
`host`	string		A helper method that just calls #bindAddress(String).
`max-header-size`	int	`16384`	Maximal number of bytes of all header values combined. When a bigger value is received, a io.helidon.common.http.Http.Status#BAD_REQUEST_400 is returned. Default is `16384`
`max-initial-line-length`	int	`4096`	Maximal number of characters in the initial HTTP line. Default is `4096`
`max-payload-size`	long		Set a maximum payload size for a client request. Can prevent DoS attacks.
`max-upgrade-content-length`	int	`65536`	Set a maximum length of the content of an upgrade request. Default is `64*1024`
`port`	int	`0`	Configures a server port to listen on with the server socket. If port is `0` then any available ephemeral port will be used.
`receive-buffer-size`	int		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.
`requested-uri-discovery.enabled`	boolean	`true if 'types' or 'trusted-proxies' is set; false otherwise`	Sets whether requested URI discovery is enabled for the socket.
`requested-uri-discovery.trusted-proxies`	AllowList		Assigns the settings governing the acceptance and rejection of forwarded headers from incoming requests to this socket. This setting automatically enables discovery for the socket.
`requested-uri-discovery.types`	RequestedUriDiscoveryType[] (FORWARDED, X_FORWARDED, HOST)	`FORWARDED if discovery is enabled; none otherwise`	Assigns the front-end URI discovery type(s) this socket should use. This setting automatically enables discovery for the socket.
`timeout-millis`	long	`0`	Socket timeout in milliseconds
`tls`	WebServerTls		Configures SSL for this socket. When configured, the server enforces SSL configuration. If this method is called, any other method except for #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.