akkasse

Type Members

1. abstract class EventPublisher[A] extends ActorPublisher[ServerSentEvent]

   

   Base class for an actor publishing events.

   Base class for an actor publishing events.

   Concrete subclasses must implement receiveEvent which becomes part of the initial behavior, i.e. gets called by the provided receive implementation. Typically receiveEvent would be implemented simply be invoking onEvent which fist appends the received event (message) to the buffer which is limited by the bufferSize parameter and then publishes the buffered events up to the total demand if this publisher is active.

   ActorPublisherMessage.Request is handled by publishing the buffered events up to the requested demand and other ActorPublisherMessages (e.g. Cancel) stop this actor.

   If the heartbeatInterval is defined, a ServerSentEvent.heartbeat will be published if no other event has been received within that interval.

   Attention: An implicit view A => ServerSentEvent has to be in scope!

2. trait EventStreamMarshalling extends AnyRef

   

   Mixing in this trait lets an akka.stream.scaladsl.Source of ServerSentEvents be marshallable to an akka.http.model.HttpResponse.

   Mixing in this trait lets an akka.stream.scaladsl.Source of ServerSentEvents be marshallable to an akka.http.model.HttpResponse.

   Attention: An implicit scala.concurrent.ExecutionContext has to be in scope!

3. trait EventStreamUnmarshalling extends AnyRef

   

   Mixing in this trait lets an akka.http.model.HttpEntity with a text/event-stream media type be unmarshallable to an akka.stream.scaladsl.Source[ServerSentEvent].

   Mixing in this trait lets an akka.http.model.HttpEntity with a text/event-stream media type be unmarshallable to an akka.stream.scaladsl.Source[ServerSentEvent].

   Attention: An implicit scala.concurrent.ExecutionContext has to be in scope!

4. final case class ServerSentEvent(data: String, eventType: Option[String] = None) extends Product with Serializable

   

   Representation of a Server-Sent Event.

   Representation of a Server-Sent Event.

   data

   data which may be empty or span multiple lines

   eventType

   optional event type, must not contain \n or \r

5. type ServerSentEventSource = Source[ServerSentEvent, Any]

   

   Just a slightly nicer name for Source[ServerSentEvent, Any].

6. type ToServerSentEvent[A] = (A) ⇒ ServerSentEvent

   

   View from A to ServerSentEvent.