Packages

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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerSentEvent
  2. Serializable
  3. Product
  4. Equals
  5. ServerSentEvent
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ServerSentEvent(data: String, eventType: Option[String] = None, id: Option[String] = None, retry: Option[Int] = None)

    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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val data: String
  9. 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
  10. 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
  11. 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
  12. 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
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val eventType: Option[String]
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getData(): String

    Data, may span multiple lines.

    Data, may span multiple lines.

    Definition Classes
    ServerSentEventServerSentEvent
  18. def getEventType(): Optional[String]

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

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

    Definition Classes
    ServerSentEventServerSentEvent
  19. def getId(): Optional[String]

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

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

    Definition Classes
    ServerSentEventServerSentEvent
  20. def getRetry(): OptionalInt

    Optional reconnection delay in milliseconds.

    Optional reconnection delay in milliseconds.

    Definition Classes
    ServerSentEventServerSentEvent
  21. val id: Option[String]
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. val retry: Option[Int]
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. 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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. 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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromServerSentEvent to any2stringadd[ServerSentEvent]

Inherited by implicit conversion StringFormat fromServerSentEvent to StringFormat[ServerSentEvent]

Inherited by implicit conversion Ensuring fromServerSentEvent to Ensuring[ServerSentEvent]

Inherited by implicit conversion ArrowAssoc fromServerSentEvent to ArrowAssoc[ServerSentEvent]

Ungrouped