Trait/Object

akka.http.scaladsl.unmarshalling.sse

EventStreamUnmarshalling

Related Docs: object EventStreamUnmarshalling | package sse

Permalink

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

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 EventStreamUnmarshalling to any2stringadd[EventStreamUnmarshalling] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from EventStreamUnmarshalling to ArrowAssoc[EventStreamUnmarshalling] 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. def ensuring(cond: (EventStreamUnmarshalling) ⇒ Boolean, msg: ⇒ Any): EventStreamUnmarshalling

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

  9. def ensuring(cond: (EventStreamUnmarshalling) ⇒ Boolean): EventStreamUnmarshalling

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): EventStreamUnmarshalling

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

  11. def ensuring(cond: Boolean): EventStreamUnmarshalling

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

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

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

  15. def formatted(fmtstr: String): String

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

  16. def fromEventsStream(settings: ServerSentEventSettings): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]

    Permalink

    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.

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

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

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

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

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

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

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

  29. def →[B](y: B): (EventStreamUnmarshalling, B)

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

Deprecated Value Members

  1. final val fromEventStream: FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]

    Permalink
    Annotations
    @deprecated
    Deprecated

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

  2. def maxEventSize: Int

    Permalink

    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)

  3. def maxLineSize: Int

    Permalink

    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)

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped