Object/Trait

akka.http.scaladsl.unmarshalling.sse

EventStreamUnmarshalling

Related Docs: trait EventStreamUnmarshalling | package sse

Permalink

object EventStreamUnmarshalling extends EventStreamUnmarshalling

Importing EventStreamUnmarshalling.fromEventsStream lets an 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. The maximum size for parsing lines of a server-sent event is 4KiB. If you need to customize any of these, set the akka.http.sse.max-event-size and akka.http.sse.max-line-size properties respectively.

Annotations
@ApiMayChange()
Source
EventStreamUnmarshalling.scala
Linear Supertypes
EventStreamUnmarshalling, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventStreamUnmarshalling
  2. EventStreamUnmarshalling
  3. AnyRef
  4. Any
  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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Definition Classes
    EventStreamUnmarshalling

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

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

    Definition Classes
    EventStreamUnmarshalling

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

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

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

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

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

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

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

Deprecated Value Members

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

    Permalink
    Definition Classes
    EventStreamUnmarshalling
    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
    Definition Classes
    EventStreamUnmarshalling
    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
    Definition Classes
    EventStreamUnmarshalling
    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 EventStreamUnmarshalling

Inherited from AnyRef

Inherited from Any

Ungrouped