EventStreamClient

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

   

   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]|
   |            |                                           v                  + - - - - - - - - - - - - - - - - - - - - - - - - - + |
     +----------o----------+                     +----------o----------+         +--------------+
   | | currentLastEventId  |                     |      getEvents      |       | |    events    |                                  | |
     +----------o----------+                     +----------o----------+         +-------o------+
   |            ^                                           |                  |         |                                         | |
                |               Source[ServerSentEvent, Any]|                            | ServerSentEvent
   |            |                                           v                  |         |                                         | |
                |                                +----------o----------+  run            +------------------------+
   |            |                                |       handle        |-------|         |                        |                | |
                |                                +----------o----------+                 |                        |
   |            |                                           |                  |         v                        v                | |
                |       (Future[Option[ServerSentEvent]], A)|                    +-------o------+         +-------o------+
   |            |                                           v                  | |   handler    |         |  lastOption  |         | |
                |                                +----------o----------+         +-------x------+         +-------x------+
   |            +--------------------------------o        unzip        |       |         A         Future[Option[ServerSentEvent]] | |
                Future[Option[ServerSentEvent]]  +----------o----------+        - - - - - - - - - - - - -x- - - - - - - - - - - - -
   |                                                        |                           (A, Future[Option[ServerSentEvent]])         |
                                                          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

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

9. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

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

    

    Definition Classes

    AnyRef → Any

11. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

12. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

14. final def notify(): Unit

    

    Definition Classes

    AnyRef

15. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

17. def toString(): String

    

    Definition Classes

    AnyRef → Any

18. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )