Trait

org.squbs.stream

PerpetualStreamBase

Related Doc: package stream

Permalink

trait PerpetualStreamBase[T] extends Actor with ActorLogging with Stash with GracefulStopHelper

Traits for perpetual streams that start and stop with the server. The simplest conforming implementation follows these requirements:

T

The type of the materialized value of the stream.

Linear Supertypes
GracefulStopHelper, GracefulStopSupport, Stash, RequiresMessageQueue[DequeBasedMessageQueueSemantics], UnrestrictedStash, StashSupport, ActorLogging, Actor, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PerpetualStreamBase
  2. GracefulStopHelper
  3. GracefulStopSupport
  4. Stash
  5. RequiresMessageQueue
  6. UnrestrictedStash
  7. StashSupport
  8. ActorLogging
  9. Actor
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Abstract Value Members

  1. implicit abstract val materializer: ActorMaterializer

    Permalink
  2. abstract def receive: akka.actor.Actor.Receive

    Permalink
    Definition Classes
    Actor

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  5. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  6. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

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

    Permalink
    Definition Classes
    Actor
  12. final def defaultLeafActorStop: Unit

    Permalink

    Default gracefully stop behavior for leaf level actors (Actors only receive the msg as input and send out a result) towards the GracefulStop message

    Default gracefully stop behavior for leaf level actors (Actors only receive the msg as input and send out a result) towards the GracefulStop message

    Simply stop itself

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  13. final def defaultMidActorStop(dependencies: List[ActorRef]): Unit

    Permalink

    Java API stopping non-leaf actors with default timeout.

    Java API stopping non-leaf actors with default timeout.

    dependencies

    All non-leaf actors to be stopped.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  14. final def defaultMidActorStop(dependencies: List[ActorRef], timeout: Duration): Unit

    Permalink

    Java API stopping non-leaf actors.

    Java API stopping non-leaf actors.

    dependencies

    All non-leaf actors to be stopped.

    timeout

    The timeout.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  15. final def defaultMidActorStop(dependencies: Iterable[ActorRef], timeout: FiniteDuration = stopTimeout / 2): Unit

    Permalink

    Default gracefully stop behavior for middle level actors (Actors rely on the results of other actors to finish their tasks) towards the GracefulStop message

    Default gracefully stop behavior for middle level actors (Actors rely on the results of other actors to finish their tasks) towards the GracefulStop message

    Simply propagate the GracefulStop message to all actors that should be stop ahead of this actor

    If some actors failed to respond to the GracefulStop message, It will send PoisonPill again

    After all the actors get terminated it stops itself

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def flowMatValue: Receive

    Permalink
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def gracefulStop(target: ActorRef, timeout: Duration): CompletionStage[Boolean]

    Permalink

    Java API for gracefulStop using the default message - PoisonPill.

    Java API for gracefulStop using the default message - PoisonPill.

    target

    The target actor to stop.

    timeout

    The timeout.

    returns

    A CompletionStage carrying true for success stopping the target.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  22. def gracefulStop(target: ActorRef, timeout: Duration, stopMessage: Any): CompletionStage[Boolean]

    Permalink

    Java API for gracefulStop.

    Java API for gracefulStop.

    target

    The target actor to stop.

    timeout

    The timeout.

    stopMessage

    The message to send to the actor for stopping.

    returns

    A CompletionStage carrying true for success stopping the target.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  23. def gracefulStop(target: ActorRef, timeout: FiniteDuration, stopMessage: Any): Future[Boolean]

    Permalink
    Definition Classes
    GracefulStopSupport
  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. lazy val killSwitch: SharedKillSwitch

    Permalink

    The kill switch to integrate into the stream.

    The kill switch to integrate into the stream. Override this if you want a different switch or one that is shared between perpetual streams.

    returns

    The kill switch.

  27. def log: LoggingAdapter

    Permalink
    Definition Classes
    ActorLogging
  28. final def matValue: T

    Permalink
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def postRestart(reason: Throwable): Unit

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

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

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

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  36. final def running: Receive

    Permalink
  37. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  38. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  39. final def starting: Receive

    Permalink
  40. def stash(): Unit

    Permalink
    Definition Classes
    StashSupport
  41. def stopTimeout: FiniteDuration

    Permalink

    Duration that the actor needs to finish the graceful stop.

    Duration that the actor needs to finish the graceful stop. Override it for customized timeout and it will be registered to the reaper Default to 5 seconds

    returns

    Duration

    Definition Classes
    GracefulStopHelper
  42. final def stopped(children: Iterable[ActorRef]): Receive

    Permalink
  43. lazy val streamRunLifecycleState: LifecycleState

    Permalink

    By default the stream is run when system state is Active.

    By default the stream is run when system state is Active. Override this if you want it to run in a different lifecycle phase.

  44. def supervisorStrategy: SupervisorStrategy

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

    Permalink
    Definition Classes
    AnyRef
  46. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  47. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Actor
  48. def unstashAll(): Unit

    Permalink
    Definition Classes
    StashSupport
  49. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from GracefulStopHelper

Inherited from GracefulStopSupport

Inherited from Stash

Inherited from RequiresMessageQueue[DequeBasedMessageQueueSemantics]

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped