Package akka.http.javadsl.model.sse
Class ServerSentEvent
java.lang.Object
akka.http.javadsl.model.sse.ServerSentEvent
- Direct Known Subclasses:
ServerSentEvent
Representation of a server-sent event. According to the specification, an empty data field
designates an event which is to be ignored which is useful for heartbeats.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ServerSentEvent
Creates a [[ServerSentEvent]].static ServerSentEvent
Creates a [[ServerSentEvent]].static ServerSentEvent
Creates a [[ServerSentEvent]].static ServerSentEvent
Creates a [[ServerSentEvent]].static ServerSentEvent
Creates a [[ServerSentEvent]].abstract String
getData()
Data, may span multiple lines.Optional type, must not contain \n or \r.getId()
Optional id, must not contain \n or \r.abstract OptionalInt
getRetry()
Optional reconnection delay in milliseconds.static ServerSentEvent
Provides a [[ServerSentEvent]] with empty data which can be used as a heartbeat
-
Constructor Details
-
ServerSentEvent
public ServerSentEvent()
-
-
Method Details
-
heartbeat
Provides a [[ServerSentEvent]] with empty data which can be used as a heartbeat -
create
Creates a [[ServerSentEvent]].- Parameters:
data
- data, may be empty or span multiple lines
-
create
Creates a [[ServerSentEvent]].- Parameters:
data
- data, may span multiple linestype
- type, must not contain \n or \r
-
create
Creates a [[ServerSentEvent]].- Parameters:
data
- data, may span multiple linestype
- type, must not contain \n or \rid
- id, must not contain \n or \r
-
create
Creates a [[ServerSentEvent]].- Parameters:
data
- data, may span multiple linesretry
- reconnection delay in milliseconds
-
create
public static ServerSentEvent create(String data, Optional<String> type, Optional<String> id, OptionalInt retry) Creates a [[ServerSentEvent]].- Parameters:
data
- data, may span multiple linestype
- optional type, must not contain \n or \rid
- optional id, must not contain \n or \rretry
- optional reconnection delay in milliseconds
-
getData
Data, may span multiple lines. -
getEventType
Optional type, must not contain \n or \r. -
getId
Optional id, must not contain \n or \r. -
getRetry
Optional reconnection delay in milliseconds.
-