Packages

object Streams

Common streaming patterns for SSE

Annotations
@deprecated
Deprecated

(Since version 2.0.0) Consider using EventStreamClient instead

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Streams
  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  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
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. def onSuccess(onResponse: (HttpResponse) ⇒ Unit)(response: Try[HttpResponse]): Unit

    A convenience for wrapping onResponse handlers where the event stream HTTP response is successful.

    A convenience for wrapping onResponse handlers where the event stream HTTP response is successful.

    onResponse

    the handler of the successful HTTP response

    response

    the response passed in by the sseFlow, which can have failed

  16. def sseFlow(onResponse: (Try[HttpResponse]) ⇒ Unit, onTermination: (Try[Done]) ⇒ Unit)(implicit ec: ExecutionContext, mat: ActorMaterializer): Flow[HttpResponse, ServerSentEvent, NotUsed]

    Provides a flow representing a common pipeline for handling the establishment of an SSE event stream and its termination.

    Provides a flow representing a common pipeline for handling the establishment of an SSE event stream and its termination. The flow produces SSE elements. This flow is intended to be used in conjunction with having established a connection and made a request. For example:

    Source
      .single(myRequest)
      .via(myConnection)
      .via(
        sseFlow(
          onSuccess { httpResponse =>
            // Do something given a successful establishment of an event stream
          },
          { outcome =>
            // Do something given that the event stream has terminated
          }
        )
      )
      .runForeach { sseEvent =>
        // Do something for each event
      }
    onResponse

    the initial response handler

    onTermination

    the handler to call when the connection has been terminated

    ec

    an execution context for certain parts of the flow mappings

    mat

    a materializer for certain parts of the flow

    returns

    a flow that emits ServerSentEvent elements

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped