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:

java.io.Serializable, scala.Equals, scala.Product

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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

$init$, productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ServerSentEvent

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

Method Detail

heartbeat

public static ServerSentEvent heartbeat()

apply

public static ServerSentEvent apply(java.lang.String data,
                                    java.lang.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(java.lang.String data,
                                    java.lang.String type,
                                    java.lang.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(java.lang.String data,
                                    int retry)

Creates a ServerSentEvent.

Parameters:

data - data, may span multiple lines

retry - reconnection delay in milliseconds

Returns:

(undocumented)

data

public java.lang.String data()

eventType

public scala.Option<java.lang.String> eventType()

id

public scala.Option<java.lang.String> id()

retry

public scala.Option<java.lang.Object> retry()

encode

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

getData

public java.lang.String getData()

Description copied from class: ServerSentEvent

Data, may span multiple lines.

Specified by:

getData in class ServerSentEvent

getEventType

public java.util.Optional<java.lang.String> getEventType()

Description copied from class: ServerSentEvent

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

Specified by:

getEventType in class ServerSentEvent

getId

public java.util.Optional<java.lang.String> getId()

Description copied from class: ServerSentEvent

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

Specified by:

getId in class ServerSentEvent

getRetry

public java.util.OptionalInt getRetry()

Description copied from class: ServerSentEvent

Optional reconnection delay in milliseconds.

Specified by:

getRetry in class ServerSentEvent