EventPublisher

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!

Linear Supertypes

ActorPublisher[ServerSentEvent], Actor, AnyRef, Any

Instance Constructors

new EventPublisher(bufferSize: Int, heartbeatInterval: Duration = Duration.Undefined)(implicit arg0: ToServerSentEvent[A])

bufferSize
the maximum number of events (messages) to be buffered
heartbeatInterval
the interval for heartbeats; if Undefined, which is the default, no heartbeats are published

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

Abstract Value Members

abstract def receiveEvent: Receive

To be implemented by invoking onEvent.
To be implemented by invoking onEvent.

Attributes
protected

Concrete 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
def aroundPostRestart(reason: Throwable): Unit

Attributes
protected[akka]
Definition Classes
ActorPublisher → Actor
def aroundPostStop(): Unit

Attributes
protected[akka]
Definition Classes
ActorPublisher → Actor
def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

Attributes
protected[akka]
Definition Classes
ActorPublisher → Actor
def aroundPreStart(): Unit

Attributes
protected[akka]
Definition Classes
ActorPublisher → Actor
def aroundReceive(receive: Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
ActorPublisher → Actor
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit val context: ActorContext

Definition Classes
Actor
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 isActive: Boolean

Definition Classes
ActorPublisher
final def isCanceled: Boolean

Definition Classes
ActorPublisher
final def isCompleted: Boolean

Definition Classes
ActorPublisher
final def isErrorEmitted: Boolean

Definition Classes
ActorPublisher
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 onComplete(): Unit

Definition Classes
ActorPublisher
def onCompleteThenStop(): Unit

Definition Classes
ActorPublisher
def onError(cause: Throwable): Unit

Definition Classes
ActorPublisher
def onErrorThenStop(cause: Throwable): Unit

Definition Classes
ActorPublisher
final def onEvent(event: A): Unit

To be invoked when an event is received.
To be invoked when an event is received.

Attributes
protected
def onNext(element: ServerSentEvent): Unit

Definition Classes
ActorPublisher
def postRestart(reason: Throwable): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def postStop(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preRestart(reason: Throwable, message: Option[Any]): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preStart(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
final def receive: PartialFunction[Any, Unit]

Receive events via onEvent and ActorPublisherMessages.
Receive events via onEvent and ActorPublisherMessages.

Definition Classes
EventPublisher → Actor
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
def subscriptionTimeout: Duration

Definition Classes
ActorPublisher
def supervisorStrategy: SupervisorStrategy

Definition Classes
Actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def totalDemand: Long

Definition Classes
ActorPublisher
def unhandled(message: Any): Unit

Definition Classes
Actor
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( ... )

Related Doc: package akkasse

abstract class EventPublisher[A] extends ActorPublisher[ServerSentEvent]

Instance Constructors

new EventPublisher(bufferSize: Int, heartbeatInterval: Duration = Duration.Undefined)(implicit arg0: ToServerSentEvent[A])

Type Members

type Receive = PartialFunction[Any, Unit]

Abstract Value Members

abstract def receiveEvent: Receive

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit val context: ActorContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isActive: Boolean

final def isCanceled: Boolean

final def isCompleted: Boolean

final def isErrorEmitted: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onComplete(): Unit

def onCompleteThenStop(): Unit

def onError(cause: Throwable): Unit

def onErrorThenStop(cause: Throwable): Unit

final def onEvent(event: A): Unit

def onNext(element: ServerSentEvent): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

final def receive: PartialFunction[Any, Unit]

implicit final val self: ActorRef

final def sender(): ActorRef

def subscriptionTimeout: Duration

def supervisorStrategy: SupervisorStrategy

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

def toString(): String

final def totalDemand: Long

def unhandled(message: Any): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from ActorPublisher[ServerSentEvent]

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped