final case class ServerSentEvent(data: String, eventType: Option[String] = None, id: Option[String] = None, retry: Option[Int] = None) extends javadsl.model.sse.ServerSentEvent with Product with Serializable
Representation of a server-sent event. By default akka-http uses events with an empty data field as a heartbeat that is
ignored on reception. Set akka.http.sse.emit-empty-events can be used to change that default behavior.
- data
data, may span multiple lines
- eventType
optional type, must not contain \n or \r
- id
optional id, must not contain \n or \r
- retry
optional reconnection delay in milliseconds
- Source
- ServerSentEvent.scala
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- ServerSentEvent
- Serializable
- Product
- Equals
- ServerSentEvent
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toany2stringadd[ServerSentEvent] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ServerSentEvent, B)
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toArrowAssoc[ServerSentEvent] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val data: String
- def ensuring(cond: (ServerSentEvent) => Boolean, msg: => Any): ServerSentEvent
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toEnsuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ServerSentEvent) => Boolean): ServerSentEvent
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toEnsuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ServerSentEvent
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toEnsuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ServerSentEvent
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toEnsuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val eventType: Option[String]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getData(): String
Data, may span multiple lines.
Data, may span multiple lines.
- Definition Classes
- ServerSentEvent → ServerSentEvent
- def getEventType(): Optional[String]
Optional type, must not contain \n or \r.
Optional type, must not contain \n or \r.
- Definition Classes
- ServerSentEvent → ServerSentEvent
- def getId(): Optional[String]
Optional id, must not contain \n or \r.
Optional id, must not contain \n or \r.
- Definition Classes
- ServerSentEvent → ServerSentEvent
- def getRetry(): OptionalInt
Optional reconnection delay in milliseconds.
Optional reconnection delay in milliseconds.
- Definition Classes
- ServerSentEvent → ServerSentEvent
- val id: Option[String]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val retry: Option[Int]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toStringFormat[ServerSentEvent] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ServerSentEvent, B)
- Implicit
- This member is added by an implicit conversion from ServerSentEvent toArrowAssoc[ServerSentEvent] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.