Package com.linecorp.armeria.common.sse

Interface ServerSentEvent

public interface ServerSentEvent

An interface for the Server-Sent Events specification. If a Publisher or Stream produces objects which implement this interface, it can be converted into a text event stream by ServerSentEventResponseConverterFunction.

See Also:

• ProducesEventStream
• ServerSentEventResponseConverterFunction

Method Summary

Modifier and Type	Method	Description
static ServerSentEventBuilder	builder()	Returns a newly created ServerSentEventBuilder.
@Nullable String	comment()	Returns a comment of this event, if it exists.
@Nullable String	data()	Returns a data of this event, if it exists.
static ServerSentEvent	empty()	Returns a singleton empty ServerSentEvent.
@Nullable String	event()	Returns an event name of this event, if it exists.
@Nullable String	id()	Returns an ID of this event, if it exists.
static ServerSentEvent	ofComment(String comment)	Creates a new ServerSentEvent with the specified comment.
static ServerSentEvent	ofData(String data)	Creates a new ServerSentEvent with the specified data.
static ServerSentEvent	ofEvent(String event)	Creates a new ServerSentEvent with the specified event.
static ServerSentEvent	ofId(String id)	Creates a new ServerSentEvent with the specified id.
static ServerSentEvent	ofRetry(Duration retry)	Creates a new ServerSentEvent with the specified retry.
@Nullable Duration	retry()	Returns a reconnection time in milliseconds, if it exists.

Method Details

empty

static ServerSentEvent empty()

Returns a singleton empty ServerSentEvent.

ofId

static ServerSentEvent ofId(String id)

Creates a new ServerSentEvent with the specified id.

ofEvent

static ServerSentEvent ofEvent(String event)

Creates a new ServerSentEvent with the specified event.

ofRetry

static ServerSentEvent ofRetry(Duration retry)

Creates a new ServerSentEvent with the specified retry.

ofComment

static ServerSentEvent ofComment(String comment)

Creates a new ServerSentEvent with the specified comment.

ofData

static ServerSentEvent ofData(String data)

Creates a new ServerSentEvent with the specified data.

builder

static ServerSentEventBuilder builder()

Returns a newly created ServerSentEventBuilder.

id

@Nullable
@Nullable String id()

Returns an ID of this event, if it exists. Otherwise, null will be returned.

event

@Nullable
@Nullable String event()

Returns an event name of this event, if it exists. Otherwise, null will be returned.

retry

@Nullable
@Nullable Duration retry()

Returns a reconnection time in milliseconds, if it exists. Otherwise, null will be returned.

comment

@Nullable
@Nullable String comment()

Returns a comment of this event, if it exists. Otherwise, null will be returned.

data

@Nullable
@Nullable String data()

Returns a data of this event, if it exists. Otherwise, null will be returned.