io.helidon.webserver.ListenerConfig

Description

Configuration of a server listener (server socket)

Configuration options

Key	Type	Default	Description
restore-response-headers	Boolean	true	Copy and restore response headers before and after passing a request to Jersey for processing
concurrency-limit	Limit		Concurrency limit to use to limit concurrent execution of incoming requests
content-encoding	ContentEncodingContext		Configure the listener specific io.helidon.http.encoding.ContentEncodingContext
media-context	MediaContext		Configure the listener specific io.helidon.http.media.MediaContext
max-payload-size	Long	-1	Maximal number of bytes an entity may have
use-nio	Boolean	true	If set to true, use NIO socket channel, instead of a socket
protocols-discover-services	Boolean	true	Whether to enable automatic service discovery for protocols
enable-proxy-protocol	Boolean	false	Enable proxy protocol support for this socket
host	String	0.0.0.0	Host of the default socket
write-queue-length	Integer	0	Number of buffers queued for write operations
protocols	List<ProtocolConfig>		Configuration of protocols
max-tcp-connections	Integer	-1	Limits the number of connections that can be opened at a single point in time
bind-address	ListenerCustomMethods		The address to bind to
idle-connection-timeout	Duration	PT5M	How long should we wait before closing a connection that has no traffic on it
shutdown-grace-period	Duration	PT0.5S	Grace period in ISO 8601 duration format to allow running tasks to complete before listener's shutdown
max-concurrent-requests	Integer	-1	Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests)
error-handling	ErrorHandling		Configuration for this listener's error handling
concurrency-limit-discover-services	Boolean	false	Whether to enable automatic service discovery for concurrency-limit
backlog	Integer	1024	Accept backlog
max-in-memory-entity	Integer	131072	If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance when writing it
ignore-invalid-named-routing	Boolean		If set to true, any named routing configured that does not have an associated named listener will NOT cause an exception to be thrown (default behavior is to throw an exception)
smart-async-writes	Boolean	false	If enabled and #writeQueueLength() is greater than 1, then start with async writes but possibly switch to sync writes if async queue size is always below a certain threshold
connection-options	SocketOptions		Options for connections accepted by this listener
port	Integer	0	Port of the default socket
requested-uri-discovery	RequestedUriDiscoveryContext		Requested URI discovery context
idle-connection-period	Duration	PT2M	How often should we check for #idleConnectionTimeout()
name	String	@default	Name of this socket
tls	Tls		Listener TLS configuration
write-buffer-size	Integer	4096	Initial buffer size in bytes of java.io.BufferedOutputStream created internally to write data to a socket connection

Deprecated Options

Key	Type	Description
connection-config	ConnectionConfig	Configuration of a connection (established from client against our server)
receive-buffer-size	Integer	Listener receive buffer size

Dependent Types

• io.helidon.webserver.WebServer

Usages

• server.sockets

---

See the manifest for all available types.