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
- Alphabetic
- By Inheritance
- EventSource
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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 Alpakka 3.0.0) pass in the actor system instead of the materializer