Packages

object EventSource

This stream processing stage establishes a continuous source of server-sent events from the given URI.

A single source of server-sent events is obtained from the URI. Once completed, either normally or by failure, a next one is obtained thereby sending a Last-Evend-ID header if available. This continues in an endless cycle.

The shape of this processing stage is a source of server-sent events; to take effect it must be connected and run. Progress (including termination) is controlled by the connected flow or sink, e.g. a retry delay can be implemented by streaming the materialized values of the handler via a throttle.

+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
                                              +---------------------+
|                                             |       trigger       | |
                                              +----------o----------+
|                                                        |            |
                                           Option[String]|
|                                                        v            |
             Option[String]                   +----------o----------+
|            +------------------------------->o        merge        | |
             |                                +----------o----------+
|            |                                           |            |
             |                             Option[String]|
|            |                                           v            |
  +----------o----------+                     +----------o----------+
| | currentLastEventId  |                     |    eventSources     | |
  +----------o----------+                     +----------o----------+
|            ^                                           |            |
             |      (EventSource, Future[Option[String]])|
|            |                                           v            |
             |                                +----------o----------+
|            +--------------------------------o        unzip        | |
             Future[Option[String]]           +----------o----------+
|                                                        |            |
                                              EventSource|
|                                                        v            |
                                              +----------o----------+
|                                  +----------o       flatten       | |
                    ServerSentEvent|          +---------------------+
|                                  v                                  |
 - - - - - - - - - - - - - - - - - o - - - - - - - - - - - - - - - - -
Source
EventSource.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventSource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def create(uri: Uri, send: Function[HttpRequest, CompletionStage[HttpResponse]], lastEventId: Optional[String], system: ClassicActorSystemProvider): Source[ServerSentEvent, NotUsed]

    uri

    URI with absolute path, e.g. "http://myserver/events

    send

    function to send a HTTP request

    lastEventId

    initial value for Last-Evend-ID header, optional

    system

    actor system (classic or new API)

    returns

    continuous source of server-sent events

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def create(uri: Uri, send: Function[HttpRequest, CompletionStage[HttpResponse]], lastEventId: Optional[String], mat: Materializer): Source[ServerSentEvent, NotUsed]

    uri

    URI with absolute path, e.g. "http://myserver/events

    send

    function to send a HTTP request

    lastEventId

    initial value for Last-Evend-ID header, optional

    mat

    Materializer

    returns

    continuous source of server-sent events

    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) pass in the actor system instead of the materializer

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped