Module ch.rasc.sse.eventbus

Package ch.rasc.sse.eventbus

Interface SseEvent

@Immutable
public interface SseEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SseEvent.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EVENT

Method Summary

Modifier and Type	Method	Description
static SseEvent.Builder	builder()
Set<String>	clientIds()
Optional<String>	comment()
Object	data()
default String	event()
Set<String>	excludeClientIds()	Is ignored when clientIds is not empty
Optional<String>	id()
Optional<Class<?>>	jsonView()
static SseEvent	of(String event, Object data)	Creates a SseEvent that just contains an event and data.
static SseEvent	ofData(Object data)	Creates a SseEvent that just contains the data.
static SseEvent	ofEvent(String event)	Creates a SseEvent that contains an event and an empty string
Optional<Duration>	retry()

Field Details

DEFAULT_EVENT

static final String DEFAULT_EVENT

See Also:

• Constant Field Values

Method Details

clientIds

Set<String> clientIds()

excludeClientIds

Set<String> excludeClientIds()

Is ignored when clientIds is not empty

jsonView

Optional<Class<?>> jsonView()

event

@Default
default String event()

data

Object data()

retry

Optional<Duration> retry()

id

Optional<String> id()

comment

Optional<String> comment()

ofData

static SseEvent ofData(Object data)

Creates a SseEvent that just contains the data. The data will be converted when it's not a String instance.

ofEvent

static SseEvent ofEvent(String event)

Creates a SseEvent that contains an event and an empty string

of

static SseEvent of(String event,
 Object data)

Creates a SseEvent that just contains an event and data. The data will be converted when it's not a String instance

builder

static SseEvent.Builder builder()