Class HandshakeResult.Accepted

java.lang.Object

com.soklet.HandshakeResult.Accepted

All Implemented Interfaces:

HandshakeResult

Enclosing interface:

HandshakeResult

@ThreadSafe
public static final class HandshakeResult.Accepted
extends Object
implements HandshakeResult

Type which indicates a successful Server-Sent Event handshake.

A default, no-customization-permitted instance can be acquired via HandshakeResult.accept() and a builder which enables customization can be acquired via builder().

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

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HandshakeResult.Accepted.Builder	Builder used to construct instances of HandshakeResult.Accepted.

Nested classes/interfaces inherited from interface HandshakeResult

HandshakeResult.Accepted, HandshakeResult.Rejected

Method Summary

Modifier and Type	Method	Description
static @NonNull HandshakeResult.Accepted.Builder	builder()	Vends a builder for an instance that indicates a successful handshake.
boolean	equals(@Nullable Object object)
@NonNull Optional<Object>	getClientContext()	Returns the client context, if specified, for this accepted Server-Sent Event handshake.
@NonNull Optional<Consumer<ServerSentEventUnicaster>>	getClientInitializer()	Returns the client initialization function, if specified, for this accepted Server-Sent Event handshake.
@Nullable Set<@NonNull ResponseCookie>	getCookies()	Returns the cookies explicitly specified when this handshake was accepted (which may be different from the finalized map of headers sent to the client).
@Nullable Map<@NonNull String, @NonNull Set<@NonNull String>>	getHeaders()	Returns the headers explicitly specified when this handshake was accepted (which may be different from the finalized map of headers sent to the client).
int	hashCode()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static @NonNull HandshakeResult.Accepted.Builder builder()

Vends a builder for an instance that indicates a successful handshake.

The builder supports specifying optional response headers, cookies, and a post-handshake client initialization hook, which is useful to "catch up" in a Last-Event-ID handshake scenario.

Returns:

a builder for an instance that indicates a successful handshake

getHeaders

public @Nullable Map<@NonNull String, @NonNull Set<@NonNull String>> getHeaders()

Returns the headers explicitly specified when this handshake was accepted (which may be different from the finalized map of headers sent to the client).

Returns:

the headers explicitly specified when this handshake was accepted

getCookies

public @Nullable Set<@NonNull ResponseCookie> getCookies()

Returns the cookies explicitly specified when this handshake was accepted (which may be different from the finalized map of headers sent to the client).

Returns:

the cookies explicitly specified when this handshake was accepted

getClientContext

public @NonNull Optional<Object> getClientContext()

Returns the client context, if specified, for this accepted Server-Sent Event handshake.

Useful for "targeted" broadcasts via ServerSentEventBroadcaster.broadcastEvent(Function, Function).

Returns:

the client context, or Optional.empty() if none was specified

getClientInitializer

public @NonNull Optional<Consumer<ServerSentEventUnicaster>> getClientInitializer()

Returns the client initialization function, if specified, for this accepted Server-Sent Event handshake.

Returns:

the client initialization function, or Optional.empty() if none was specified

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object