Class SseServer.Builder

java.lang.Object

com.soklet.SseServer.Builder

Enclosing interface:

SseServer

@NotThreadSafe
public static final class SseServer.Builder
extends Object

Builder used to construct a standard implementation of SseServer.

This class is intended for use by a single thread.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull SseServer.Builder	broadcasterCacheCapacity(@Nullable Integer broadcasterCacheCapacity)
@NonNull SseServer	build()
@NonNull SseServer.Builder	concurrentConnectionLimit(@Nullable Integer concurrentConnectionLimit)
@NonNull SseServer.Builder	connectionQueueCapacity(@Nullable Integer connectionQueueCapacity)
@NonNull SseServer.Builder	heartbeatInterval(@Nullable Duration heartbeatInterval)
@NonNull SseServer.Builder	host(@Nullable String host)
@NonNull SseServer.Builder	idGenerator(@Nullable IdGenerator<?> idGenerator)
@NonNull SseServer.Builder	maximumHeaderCount(@Nullable Integer maximumHeaderCount)	Sets the maximum number of HTTP header fields accepted in one SSE handshake.
@NonNull SseServer.Builder	maximumRequestSizeInBytes(@Nullable Integer maximumRequestSizeInBytes)	Sets the maximum accepted SSE handshake request size in bytes.
@NonNull SseServer.Builder	maximumRequestTargetLengthInBytes(@Nullable Integer maximumRequestTargetLengthInBytes)	Sets the maximum SSE handshake request-target length accepted in bytes.
@NonNull SseServer.Builder	port(@NonNull Integer port)
@NonNull SseServer.Builder	requestHandlerConcurrency(@Nullable Integer requestHandlerConcurrency)
@NonNull SseServer.Builder	requestHandlerExecutorServiceSupplier(@Nullable Supplier<ExecutorService> requestHandlerExecutorServiceSupplier)
@NonNull SseServer.Builder	requestHandlerQueueCapacity(@Nullable Integer requestHandlerQueueCapacity)
@NonNull SseServer.Builder	requestHandlerTimeout(@Nullable Duration requestHandlerTimeout)
@NonNull SseServer.Builder	requestHeaderTimeout(@Nullable Duration requestHeaderTimeout)	Sets the maximum duration for reading the SSE handshake request line and headers.
@NonNull SseServer.Builder	requestReadBufferSizeInBytes(@Nullable Integer requestReadBufferSizeInBytes)
@NonNull SseServer.Builder	resourcePathCacheCapacity(@Nullable Integer resourcePathCacheCapacity)
@NonNull SseServer.Builder	shutdownTimeout(@Nullable Duration shutdownTimeout)
@NonNull SseServer.Builder	verifyConnectionOnceEstablished(@Nullable Boolean verifyConnectionOnceEstablished)
@NonNull SseServer.Builder	writeTimeout(@Nullable Duration writeTimeout)

Methods inherited from class Object

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

Method Details

port

public @NonNull SseServer.Builder port(@NonNull Integer port)

host

public @NonNull SseServer.Builder host(@Nullable String host)

requestHeaderTimeout

public @NonNull SseServer.Builder requestHeaderTimeout(@Nullable Duration requestHeaderTimeout)

Sets the maximum duration for reading the SSE handshake request line and headers.

If this value is not specified, Soklet uses the server default.

Parameters:

requestHeaderTimeout - the request header timeout, or null for the default

Returns:

this builder

requestHandlerTimeout

public @NonNull SseServer.Builder requestHandlerTimeout(@Nullable Duration requestHandlerTimeout)

requestHandlerConcurrency

public @NonNull SseServer.Builder requestHandlerConcurrency(@Nullable Integer requestHandlerConcurrency)

requestHandlerQueueCapacity

public @NonNull SseServer.Builder requestHandlerQueueCapacity(@Nullable Integer requestHandlerQueueCapacity)

writeTimeout

public @NonNull SseServer.Builder writeTimeout(@Nullable Duration writeTimeout)

shutdownTimeout

public @NonNull SseServer.Builder shutdownTimeout(@Nullable Duration shutdownTimeout)

heartbeatInterval

public @NonNull SseServer.Builder heartbeatInterval(@Nullable Duration heartbeatInterval)

maximumRequestSizeInBytes

public @NonNull SseServer.Builder maximumRequestSizeInBytes(@Nullable Integer maximumRequestSizeInBytes)

Sets the maximum accepted SSE handshake request size in bytes.

This limit applies to the whole received handshake request, including request line and headers. Established SSE stream writes are governed by the write timeout and connection queue capacity settings instead.

Parameters:

maximumRequestSizeInBytes - the maximum handshake request size, or null for the default

Returns:

this builder

maximumHeaderCount

public @NonNull SseServer.Builder maximumHeaderCount(@Nullable Integer maximumHeaderCount)

Sets the maximum number of HTTP header fields accepted in one SSE handshake.

Parameters:

maximumHeaderCount - the maximum header count, or null for the default

Returns:

this builder

maximumRequestTargetLengthInBytes

public @NonNull SseServer.Builder maximumRequestTargetLengthInBytes(@Nullable Integer maximumRequestTargetLengthInBytes)

Sets the maximum SSE handshake request-target length accepted in bytes.

Parameters:

maximumRequestTargetLengthInBytes - the maximum request-target length, or null for the default

Returns:

this builder

requestReadBufferSizeInBytes

public @NonNull SseServer.Builder requestReadBufferSizeInBytes(@Nullable Integer requestReadBufferSizeInBytes)

requestHandlerExecutorServiceSupplier

public @NonNull SseServer.Builder requestHandlerExecutorServiceSupplier(@Nullable Supplier<ExecutorService> requestHandlerExecutorServiceSupplier)

concurrentConnectionLimit

public @NonNull SseServer.Builder concurrentConnectionLimit(@Nullable Integer concurrentConnectionLimit)

broadcasterCacheCapacity

public @NonNull SseServer.Builder broadcasterCacheCapacity(@Nullable Integer broadcasterCacheCapacity)

resourcePathCacheCapacity

public @NonNull SseServer.Builder resourcePathCacheCapacity(@Nullable Integer resourcePathCacheCapacity)

connectionQueueCapacity

public @NonNull SseServer.Builder connectionQueueCapacity(@Nullable Integer connectionQueueCapacity)

verifyConnectionOnceEstablished

public @NonNull SseServer.Builder verifyConnectionOnceEstablished(@Nullable Boolean verifyConnectionOnceEstablished)

idGenerator

public @NonNull SseServer.Builder idGenerator(@Nullable IdGenerator<?> idGenerator)

build

public @NonNull SseServer build()