Class SseHandshakeResult.Accepted.Builder

java.lang.Object

com.soklet.SseHandshakeResult.Accepted.Builder

Enclosing class:

SseHandshakeResult.Accepted

@NotThreadSafe
public static final class SseHandshakeResult.Accepted.Builder
extends Object

Builder used to construct instances of SseHandshakeResult.Accepted.

This class is intended for use by a single thread.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull SseHandshakeResult.Accepted	build()
@NonNull SseHandshakeResult.Accepted.Builder	clientContext(@Nullable Object clientContext)	Specifies an application-specific custom context to be preserved over the lifetime of the SSE connection.
@NonNull SseHandshakeResult.Accepted.Builder	clientInitializer(@Nullable Consumer<SseUnicaster> clientInitializer)	Specifies custom "client initializer" function to run immediately after the handshake succeeds - useful for performing "catch-up" logic if the client had provided a Last-Event-ID request header.
@NonNull SseHandshakeResult.Accepted.Builder	cookies(@Nullable Set<@NonNull ResponseCookie> cookies)	Specifies custom response cookies to be sent with the handshake.
@NonNull SseHandshakeResult.Accepted.Builder	headers(@Nullable Map<@NonNull String, @NonNull Set<@NonNull String>> headers)	Specifies custom response headers to be sent with the handshake.

Methods inherited from class Object

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

Method Details

headers

public @NonNull SseHandshakeResult.Accepted.Builder headers(@Nullable Map<@NonNull String, @NonNull Set<@NonNull String>> headers)

Specifies custom response headers to be sent with the handshake.

Parameters:

headers - custom response headers to send

Returns:

this builder, for chaining

cookies

public @NonNull SseHandshakeResult.Accepted.Builder cookies(@Nullable Set<@NonNull ResponseCookie> cookies)

Specifies custom response cookies to be sent with the handshake.

Parameters:

cookies - custom response cookies to send

Returns:

this builder, for chaining

clientContext

public @NonNull SseHandshakeResult.Accepted.Builder clientContext(@Nullable Object clientContext)

Specifies an application-specific custom context to be preserved over the lifetime of the SSE connection.

For example, an application might want to broadcast differently-formatted payloads based on the client's locale - a Locale object could be specified as client context.

Server-Sent Events can then be broadcast per-locale via SseBroadcaster.broadcastEvent(Function, Function).

Parameters:

clientContext - custom context

Returns:

this builder, for chaining

clientInitializer

public @NonNull SseHandshakeResult.Accepted.Builder clientInitializer(@Nullable Consumer<SseUnicaster> clientInitializer)

Specifies custom "client initializer" function to run immediately after the handshake succeeds - useful for performing "catch-up" logic if the client had provided a Last-Event-ID request header.

The function is provided with a SseUnicaster, which permits sending Server-Sent Events and comments directly to the client that accepted the handshake (as opposed to a SseBroadcaster, which would send to all clients listening on the same ResourcePath).

Full documentation is available at https://www.soklet.com/docs/server-sent-events.

Parameters:

clientInitializer - custom function to run to initialize the client

Returns:

this builder, for chaining

build

public @NonNull SseHandshakeResult.Accepted build()