Package org.apache.pekko.http.scaladsl.model.sse

Class ServerSentEvent

java.lang.Object

org.apache.pekko.http.javadsl.model.sse.ServerSentEvent

org.apache.pekko.http.scaladsl.model.sse.ServerSentEvent

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public final class ServerSentEvent
extends ServerSentEvent
implements scala.Product, Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServerSentEvent(String data, scala.Option<String> eventType, scala.Option<String> id, scala.Option<Object> retry)

Method Summary

Modifier and Type	Method	Description
static ServerSentEvent	apply(String data, int retry)	Creates a ServerSentEvent.
static ServerSentEvent	apply(String data, String type)	Creates a ServerSentEvent.
static ServerSentEvent	apply(String data, String type, String id)	Creates a ServerSentEvent.
String	data()
org.apache.pekko.util.ByteString	encode()
scala.Option<String>	eventType()
String	getData()	Data, may span multiple lines.
Optional<String>	getEventType()	Optional type, must not contain \n or \r.
Optional<String>	getId()	Optional id, must not contain \n or \r.
OptionalInt	getRetry()	Optional reconnection delay in milliseconds.
static ServerSentEvent	heartbeat()
scala.Option<String>	id()
scala.Option<Object>	retry()

Methods inherited from class org.apache.pekko.http.javadsl.model.sse.ServerSentEvent

create, create, create, create, create

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

ServerSentEvent

public ServerSentEvent(String data,
 scala.Option<String> eventType,
 scala.Option<String> id,
 scala.Option<Object> retry)

Method Details

heartbeat

public static ServerSentEvent heartbeat()

apply

public static ServerSentEvent apply(String data,
 String type)

Creates a ServerSentEvent.

Parameters:

data - data, may span multiple lines

type - type, must not contain \n or \r

Returns:

(undocumented)

apply

public static ServerSentEvent apply(String data,
 String type,
 String id)

Creates a ServerSentEvent.

Parameters:

data - data, may span multiple lines

type - type, must not contain \n or \r

id - id, must not contain \n or \r

Returns:

(undocumented)

apply

public static ServerSentEvent apply(String data,
 int retry)

Creates a ServerSentEvent.

Parameters:

data - data, may span multiple lines

retry - reconnection delay in milliseconds

Returns:

(undocumented)

data

public String data()

eventType

public scala.Option<String> eventType()

id

public scala.Option<String> id()

retry

public scala.Option<Object> retry()

encode

public org.apache.pekko.util.ByteString encode()

getData

public String getData()

Description copied from class: ServerSentEvent

Data, may span multiple lines.

Specified by:

getData in class ServerSentEvent

getEventType

public Optional<String> getEventType()

Description copied from class: ServerSentEvent

Optional type, must not contain \n or \r.

Specified by:

getEventType in class ServerSentEvent

getId

public Optional<String> getId()

Description copied from class: ServerSentEvent

Optional id, must not contain \n or \r.

Specified by:

getId in class ServerSentEvent

getRetry

public OptionalInt getRetry()

Description copied from class: ServerSentEvent

Optional reconnection delay in milliseconds.

Specified by:

getRetry in class ServerSentEvent