AbstractPerpetualStream

Instance Constructors

new AbstractPerpetualStream()

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

Abstract Value Members

abstract def streamGraph: RunnableGraph[T]

Describe your graph by implementing streamGraph
Describe your graph by implementing streamGraph
returns
The graph.

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
Actor
Annotations
@InternalApi()
def aroundPostStop(): Unit

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

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

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

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
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
def createReceive(): akka.actor.AbstractActor.Receive

Definition Classes
AbstractPerpetualStream → AbstractActor
def decider: Function[Throwable, Directive]

The decider to use.
The decider to use. Override if not resumingDecider.
final def defaultLeafActorStop: Unit

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
final def defaultMidActorStop(dependencies: List[ActorRef]): Unit

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
final def defaultMidActorStop(dependencies: List[ActorRef], timeout: Duration): Unit

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
final def defaultMidActorStop(dependencies: Iterable[ActorRef], timeout: FiniteDuration = stopTimeout / 2): Unit

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
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 flowMatValue: Receive

Definition Classes
PerpetualStreamBase
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getContext(): ActorContext

Definition Classes
AbstractActor
def getSelf(): ActorRef

Definition Classes
AbstractActor
def getSender(): ActorRef

Definition Classes
AbstractActor
def getStopTimeout: Long

Override getStopTimeout to set a custom stop timeout.
Override getStopTimeout to set a custom stop timeout.
returns
The timeout, in milliseconds to allow for stopping the server.
final def gracefulStop(target: ActorRef, timeout: Duration): CompletionStage[Boolean]

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
def gracefulStop(target: ActorRef, timeout: Duration, stopMessage: Any): CompletionStage[Boolean]

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
def gracefulStop(target: ActorRef, timeout: FiniteDuration, stopMessage: Any): Future[Boolean]

Definition Classes
GracefulStopSupport
def hashCode(): Int

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

Definition Classes
Any
lazy val killSwitch: SharedKillSwitch

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.

Definition Classes
PerpetualStreamBase
def log: LoggingAdapter

Definition Classes
ActorLogging
final def matValue: T

Definition Classes
PerpetualStreamBase
implicit val materializer: ActorMaterializer

Definition Classes
AbstractPerpetualStream → PerpetualStreamBase
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

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

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

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

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

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

Definition Classes
AbstractActor → Actor
final def receiveBuilder(): ReceiveBuilder

Definition Classes
AbstractActor
final def running: Receive

Definition Classes
PerpetualStreamBase
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
def shutdown(): CompletionStage[Done]

Override shutdown to define your own shutdown process or wait for the sink to finish.
Override shutdown to define your own shutdown process or wait for the sink to finish. The default shutdown makes the following assumptions:
- The stream materializes to a CompletionStage, or a Pair or List for which the last element is a CompletionStage
- This CompletionStage represents the state whether the stream is done
- The stream has the killSwitch as the first processing stage In which case you do not need to override this default shutdown if there are no further shutdown requirements. In case you override shutdown, it is recommended that super.shutdown() be called on overrides even if the stream only partially meets the requirements above.
returns
A CompletionStage[Done] that gets completed when the whole stream is done.
final def starting: Receive

Definition Classes
PerpetualStreamBase
def stash(): Unit

Definition Classes
StashSupport
final def stopTimeout: FiniteDuration

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
AbstractPerpetualStream → GracefulStopHelper
final def stopped(children: Iterable[ActorRef]): Receive

Definition Classes
PerpetualStreamBase
lazy val streamRunLifecycleState: LifecycleState

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.

Definition Classes
PerpetualStreamBase
def supervisorStrategy: SupervisorStrategy

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

Definition Classes
AnyRef
def toString(): String

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

Definition Classes
Actor
def unstashAll(): Unit

Definition Classes
StashSupport
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 stream

abstract class AbstractPerpetualStream[T] extends AbstractActor with PerpetualStreamBase[T]

Instance Constructors

new AbstractPerpetualStream()

Type Members

type Receive = PartialFunction[Any, Unit]

Abstract Value Members

abstract def streamGraph: RunnableGraph[T]

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: akka.actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit val context: ActorContext

def createReceive(): akka.actor.AbstractActor.Receive

def decider: Function[Throwable, Directive]

final def defaultLeafActorStop: Unit

final def defaultMidActorStop(dependencies: List[ActorRef]): Unit

final def defaultMidActorStop(dependencies: List[ActorRef], timeout: Duration): Unit

final def defaultMidActorStop(dependencies: Iterable[ActorRef], timeout: FiniteDuration = stopTimeout / 2): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def flowMatValue: Receive

final def getClass(): Class[_]

def getContext(): ActorContext

def getSelf(): ActorRef

def getSender(): ActorRef

def getStopTimeout: Long

final def gracefulStop(target: ActorRef, timeout: Duration): CompletionStage[Boolean]

def gracefulStop(target: ActorRef, timeout: Duration, stopMessage: Any): CompletionStage[Boolean]

def gracefulStop(target: ActorRef, timeout: FiniteDuration, stopMessage: Any): Future[Boolean]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

lazy val killSwitch: SharedKillSwitch

def log: LoggingAdapter

final def matValue: T

implicit val materializer: ActorMaterializer

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

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

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

def preStart(): Unit

def receive: PartialFunction[Any, Unit]

final def receiveBuilder(): ReceiveBuilder

final def running: Receive

implicit final val self: ActorRef

final def sender(): ActorRef

def shutdown(): CompletionStage[Done]

final def starting: Receive

def stash(): Unit

final def stopTimeout: FiniteDuration

final def stopped(children: Iterable[ActorRef]): Receive

lazy val streamRunLifecycleState: LifecycleState

def supervisorStrategy: SupervisorStrategy

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

def toString(): String

def unhandled(message: Any): Unit

def unstashAll(): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from PerpetualStreamBase[T]

Inherited from GracefulStopHelper

Inherited from GracefulStopSupport

Inherited from Stash

Inherited from RequiresMessageQueue[DequeBasedMessageQueueSemantics]

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from ActorLogging