Packages

trait EventStreamUnmarshalling extends AnyRef

Mixing in this trait lets a HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

The maximum size for parsing server-sent events is 8KiB by default and can be customized by configuring akka.http.sse.max-event-size. The maximum size for parsing lines of a server-sent event is 4KiB by default and can be customized by configuring akka.http.sse.max-line-size.

Annotations
@ApiMayChange()
Source
EventStreamUnmarshalling.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
EventStreamUnmarshalling
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventStreamUnmarshalling
  2. AnyRef
  3. 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

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 EventStreamUnmarshalling toany2stringadd[EventStreamUnmarshalling] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EventStreamUnmarshalling, B)
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toArrowAssoc[EventStreamUnmarshalling] 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]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (EventStreamUnmarshalling) => Boolean, msg: => Any): EventStreamUnmarshalling
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EventStreamUnmarshalling) => Boolean): EventStreamUnmarshalling
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): EventStreamUnmarshalling
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EventStreamUnmarshalling
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def fromEventsStream(settings: ServerSentEventSettings): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]

    Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

    Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

    settings

    overrides the default unmarshalling behavior.

  15. implicit final def fromEventsStream(implicit system: ActorSystem): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]

    Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toStringFormat[EventStreamUnmarshalling] 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.

  3. final val fromEventStream: FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
    Annotations
    @deprecated
    Deprecated

    (Since version 10.1.8) Binary compatibility method. Invocations should have an implicit ActorSystem in scope to provide access to configuration

  4. def maxEventSize: Int

    The maximum size for parsing server-sent events; 8KiB by default.

    The maximum size for parsing server-sent events; 8KiB by default.

    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 10.1.8) Set this property in configuration as akka.http.sse.max-event-size before calling fromEventsStream(implicit ActorSystem)

  5. def maxLineSize: Int

    The maximum size for parsing lines of a server-sent event; 4KiB by default.

    The maximum size for parsing lines of a server-sent event; 4KiB by default.

    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 10.1.8) Set this property in configuration as akka.http.sse.max-line-size before calling fromEventsStream(implicit ActorSystem)

  6. def →[B](y: B): (EventStreamUnmarshalling, B)
    Implicit
    This member is added by an implicit conversion from EventStreamUnmarshalling toArrowAssoc[EventStreamUnmarshalling] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEventStreamUnmarshalling to any2stringadd[EventStreamUnmarshalling]

Inherited by implicit conversion StringFormat fromEventStreamUnmarshalling to StringFormat[EventStreamUnmarshalling]

Inherited by implicit conversion Ensuring fromEventStreamUnmarshalling to Ensuring[EventStreamUnmarshalling]

Inherited by implicit conversion ArrowAssoc fromEventStreamUnmarshalling to ArrowAssoc[EventStreamUnmarshalling]

Ungrouped