object Streams
Common streaming patterns for SSE
- Annotations
- @deprecated
- Deprecated
(Since version 2.0.0) Consider using EventStreamClient instead
- Alphabetic
- By Inheritance
- Streams
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )