Class/Object

akka.http.scaladsl.model.sse

ServerSentEvent

Related Docs: object ServerSentEvent | package sse

Permalink

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. According to the specification, an empty data field designates an event which is to be ignored which is useful for heartbeats.

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

Instance Constructors

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to any2stringadd[ServerSentEvent] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ServerSentEvent, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to ArrowAssoc[ServerSentEvent] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val data: String

    Permalink

    data, may span multiple lines

  9. def ensuring(cond: (ServerSentEvent) ⇒ Boolean, msg: ⇒ Any): ServerSentEvent

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to Ensuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (ServerSentEvent) ⇒ Boolean): ServerSentEvent

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to Ensuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): ServerSentEvent

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to Ensuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): ServerSentEvent

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to Ensuring[ServerSentEvent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. val eventType: Option[String]

    Permalink

    optional type, must not contain \n or \r

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to StringFormat[ServerSentEvent] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def getData(): String

    Permalink
    Definition Classes
    ServerSentEvent → ServerSentEvent

  19. def getEventType(): Optional[String]

    Permalink
    Definition Classes
    ServerSentEvent → ServerSentEvent

  20. def getId(): Optional[String]

    Permalink
    Definition Classes
    ServerSentEvent → ServerSentEvent

  21. def getRetry(): OptionalInt

    Permalink
    Definition Classes
    ServerSentEvent → ServerSentEvent

  22. val id: Option[String]

    Permalink

    optional id, must not contain \n or \r

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. val retry: Option[Int]

    Permalink

    optional reconnection delay in milliseconds

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def →[B](y: B): (ServerSentEvent, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServerSentEvent to ArrowAssoc[ServerSentEvent] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from javadsl.model.sse.ServerSentEvent

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ServerSentEvent to any2stringadd[ServerSentEvent]

Inherited by implicit conversion StringFormat from ServerSentEvent to StringFormat[ServerSentEvent]

Inherited by implicit conversion Ensuring from ServerSentEvent to Ensuring[ServerSentEvent]

Inherited by implicit conversion ArrowAssoc from ServerSentEvent to ArrowAssoc[ServerSentEvent]

Ungrouped