Object

de.heikoseeberger.akkasse.client

EventStreamClient

Related Doc: package client

Permalink

object EventStreamClient

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventStreamClient
  2. AnyRef
  3. 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. def apply[A](uri: Uri, handler: Sink[ServerSentEvent, A], send: (HttpRequest) ⇒ Future[HttpResponse], lastEventId: Option[String] = None)(implicit ec: ExecutionContext, mat: Materializer): Source[A, NotUsed]

    Permalink

    This stream processing stage establishes and handles a quasi-continuous EventStream from the given URI.

    This stream processing stage establishes and handles a quasi-continuous EventStream from the given URI.

    A single EventStream is obtained from the URI and run with the given handler. Once completed, either normally or by failure, a next one is obtained thereby sending a Last-Evend-ID header if available. Hence obtaining and handling happens in an endless cycle.

    The shape of this processing stage is a source of materialized values of the given handler. To take effect it must be run. Progress (including termination) is controlled by the connected sink, e.g. a retry delay can be implemented by streaming the materialized values of the handler into a throttle.

    + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
                                                  +---------------------+
    |                                             |       trigger       |                                                           |
                                                  +----------o----------+
    |                                                        |                                                                      |
                                               Option[String]|
    |                                                        v                                                                      |
                 Option[String]                   +----------o----------+
    |            +------------------------------->o        merge        |                                                           |
                 |                                +----------o----------+       + - - - - - - - - - - - - - - - - - - - - - - - - +
    |            |                                           |                    +--------------+                                  |
                 |                             Option[String]|                  | |    events    |                                |
    |            |                                           v                    +-------o------+                                  |
      +----------o----------+                     +----------o----------+       |         |                                       |
    | | currentLastEventId  |                     |      getEvents      |                 |ServerSentEvent                          |
      +----------o----------+                     +----------o----------+       |         v                                       |
    |            ^                                           |                    +-------o------+                                  |
                 |               Source[ServerSentEvent, Any]|                  | | LastElement  x Future[Option[ServerSentEvent]]|
    |            |                                           v                    +-------o------+                                  |
                 |                                +----------o----------+  run  |         |                                       |
    |            |                                |       handle        |-------          |ServerSentEvent                          |
                 |                                +----------o----------+       |         v                                       |
    |            |                                           |                    +-------o------+                                  |
                 |       (Future[Option[ServerSentEvent]], A)|                  | |   handler    x A                              |
    |            |                                           v                    +--------------+                                  |
                 |                                +----------o----------+       + - - - - - - - - - - - - - - - - - - - - - - - - +
    |            +--------------------------------o        unzip        |                                                           |
                 Future[Option[ServerSentEvent]]  +----------o----------+
    |                                                        |                                                                      |
                                                           A |
    |                                                        |                                                                      |
                                                             v
    + - - - - - - - - - - - - - - - - - - - - - - - - - - - -o- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    uri

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

    handler

    handler for ServerSentEvents

    lastEventId

    initial value for Last-Evend-ID header, optional

    ec

    implicit ExecutionContext

    mat

    implicit Materializer

    returns

    source of materialized values of the handler

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped