Class ServerSentEvent

java.lang.Object

com.soklet.ServerSentEvent

@ThreadSafe
public class ServerSentEvent
extends Object

Encapsulates a Server-Sent Event payload that can be sent across the wire to a client.

For example:

 ServerSentEvent serverSentEvent = ServerSentEvent.withEvent("example")
  .data("""
    {
      "testing": 123,
      "value": "abc"
    }
    """)
  .id(UUID.randomUUID().toString())
  .retry(Duration.ofSeconds(5))
  .build();

To acquire an event suitable for heartbeats, use the forHeartbeat() factory method.

See https://www.soklet.com/docs/server-sent-events for detailed documentation.

Formal specification is available at https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerSentEvent.Builder	Builder used to construct instances of ServerSentEvent via withEvent(String) or withData(String).

Method Summary

Modifier and Type	Method	Description
static ServerSentEvent.Builder	builder()	Acquires an "empty" builder for ServerSentEvent instances.
static ServerSentEvent	forHeartbeat()	Acquires a reference to the shared "heartbeat" event.
Optional<String>	getData()	The data payload for this Server-Sent Event.
Optional<String>	getEvent()	The event value for this Server-Sent Event.
Optional<String>	getId()	The id for this Server-Sent Event, used by clients to populate the Last-Event-ID request header should a reconnect occur.
Optional<Duration>	getRetry()	The retry duration for this Server-Sent Event.
Boolean	isHeartbeat()	Is this instance the shared "heartbeat" event (as provided via forHeartbeat())?
String	toString()
static ServerSentEvent.Builder	withData(String data)	Acquires a builder for ServerSentEvent instances, seeded with a data value.
static ServerSentEvent.Builder	withEvent(String event)	Acquires a builder for ServerSentEvent instances, seeded with an event value.

Methods inherited from class Object

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

Method Details

forHeartbeat

@Nonnull
public static ServerSentEvent forHeartbeat()

Acquires a reference to the shared "heartbeat" event.

Returns:

the shared "heartbeat" event

withEvent

@Nonnull
public static ServerSentEvent.Builder withEvent(@Nullable
 String event)

Acquires a builder for ServerSentEvent instances, seeded with an event value.

Parameters:

event - the event value for the instance

Returns:

the builder

withData

@Nonnull
public static ServerSentEvent.Builder withData(@Nullable
 String data)

Acquires a builder for ServerSentEvent instances, seeded with a data value.

Parameters:

data - the data value for the instance

Returns:

the builder

builder

@Nonnull
public static ServerSentEvent.Builder builder()

Acquires an "empty" builder for ServerSentEvent instances.

Returns:

the builder

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

isHeartbeat

@Nonnull
public Boolean isHeartbeat()

Is this instance the shared "heartbeat" event (as provided via forHeartbeat())?

Returns:

true if this instance is the shared "heartbeat" event, false otherwise

getId

@Nonnull
public Optional<String> getId()

The id for this Server-Sent Event, used by clients to populate the Last-Event-ID request header should a reconnect occur.

Formal specification is available at https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events.

Returns:

the optional id for this Server-Sent Event

getEvent

@Nonnull
public Optional<String> getEvent()

The event value for this Server-Sent Event.

Formal specification is available at https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events.

Returns:

the optional event value for this Server-Sent Event

getData

@Nonnull
public Optional<String> getData()

The data payload for this Server-Sent Event.

Formal specification is available at https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events.

Returns:

the optional data payload for this Server-Sent Event

getRetry

@Nonnull
public Optional<Duration> getRetry()

The retry duration for this Server-Sent Event.

Formal specification is available at https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events.

Returns:

the optional retry duration for this Server-Sent Event