Class ActorMaterializer
- java.lang.Object
-
- akka.stream.Materializer
-
- akka.stream.ActorMaterializer
-
- All Implemented Interfaces:
MaterializerLoggingProvider
- Direct Known Subclasses:
ExtendedActorMaterializer
public abstract class ActorMaterializer extends Materializer implements MaterializerLoggingProvider
Shuts down this materializer and all the operators that have been materialized through this materializer. After having shut down, this materializer cannot be used again. Any attempt to materialize operators after having shut down will result in an IllegalStateException being thrown at materialization time.
-
-
Constructor Summary
Constructors Constructor Description ActorMaterializer()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ActorRef
actorOf(MaterializationContext context, Props props)
INTERNAL APIstatic ActorMaterializer
apply(ActorMaterializerSettings materializerSettings, ActorRefFactory context)
Scala API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.static ActorMaterializer
apply(ActorMaterializerSettings materializerSettings, java.lang.String namePrefix, ActorRefFactory context)
Scala API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.static ActorMaterializer
apply(scala.Option<ActorMaterializerSettings> materializerSettings, scala.Option<java.lang.String> namePrefix, ActorRefFactory context)
static scala.Option<ActorMaterializerSettings>
apply$default$1()
static scala.Option<java.lang.String>
apply$default$2()
static ActorMaterializer
create(ActorRefFactory context)
Java API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.static ActorMaterializer
create(ActorMaterializerSettings settings, ActorRefFactory context)
Java API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.static ActorMaterializer
create(ActorMaterializerSettings settings, ActorRefFactory context, java.lang.String namePrefix)
Java API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.abstract boolean
isShutdown()
Indicates if the materializer has been shut down.abstract LoggingAdapter
logger()
INTERNAL APIabstract ActorMaterializerSettings
settings()
abstract void
shutdown()
Shuts down this materializer and all the operators that have been materialized through this materializer.abstract ActorRef
supervisor()
INTERNAL APIabstract ActorSystem
system()
INTERNAL APIstatic ActorMaterializer
systemMaterializer(ActorMaterializerSettings materializerSettings, java.lang.String namePrefix, ExtendedActorSystem system)
INTERNAL API: Creates theStreamSupervisor
as a system actor.-
Methods inherited from class akka.stream.Materializer
executionContext, materialize, materialize, matFromSystem, scheduleOnce, schedulePeriodically, withNamePrefix
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface akka.stream.MaterializerLoggingProvider
makeLogger
-
-
-
-
Method Detail
-
apply
public static ActorMaterializer apply(scala.Option<ActorMaterializerSettings> materializerSettings, scala.Option<java.lang.String> namePrefix, ActorRefFactory context)
-
apply
public static ActorMaterializer apply(ActorMaterializerSettings materializerSettings, java.lang.String namePrefix, ActorRefFactory context)
Scala API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.The required
ActorRefFactory
(which can be either anActorSystem
or anActorContext
) will be used to create these actors, therefore it is *forbidden* to pass this object to another actor if the factory is an ActorContext.The
namePrefix
is used as the first part of the names of the actors running the processing steps. The defaultnamePrefix
is"flow"
. The actor names are built up ofnamePrefix-flowNumber-flowStepNumber-stepName
.- Parameters:
materializerSettings
- (undocumented)namePrefix
- (undocumented)context
- (undocumented)- Returns:
- (undocumented)
-
apply
public static ActorMaterializer apply(ActorMaterializerSettings materializerSettings, ActorRefFactory context)
Scala API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.The required
ActorRefFactory
(which can be either anActorSystem
or anActorContext
) will be used to create these actors, therefore it is *forbidden* to pass this object to another actor if the factory is an ActorContext.The
namePrefix
is used as the first part of the names of the actors running the processing steps. The defaultnamePrefix
is"flow"
. The actor names are built up ofnamePrefix-flowNumber-flowStepNumber-stepName
.- Parameters:
materializerSettings
- (undocumented)context
- (undocumented)- Returns:
- (undocumented)
-
apply$default$1
public static scala.Option<ActorMaterializerSettings> apply$default$1()
-
apply$default$2
public static scala.Option<java.lang.String> apply$default$2()
-
systemMaterializer
public static ActorMaterializer systemMaterializer(ActorMaterializerSettings materializerSettings, java.lang.String namePrefix, ExtendedActorSystem system)
INTERNAL API: Creates theStreamSupervisor
as a system actor.- Parameters:
materializerSettings
- (undocumented)namePrefix
- (undocumented)system
- (undocumented)- Returns:
- (undocumented)
-
create
public static ActorMaterializer create(ActorRefFactory context)
Java API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.The required
ActorRefFactory
(which can be either anActorSystem
or anActorContext
) will be used to create these actors, therefore it is *forbidden* to pass this object to another actor if the factory is an ActorContext.Defaults the actor name prefix used to name actors running the processing steps to
"flow"
. The actor names are built up ofnamePrefix-flowNumber-flowStepNumber-stepName
.- Parameters:
context
- (undocumented)- Returns:
- (undocumented)
-
create
public static ActorMaterializer create(ActorMaterializerSettings settings, ActorRefFactory context)
Java API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.The required
ActorRefFactory
(which can be either anActorSystem
or anActorContext
) will be used to create one actor that in turn creates actors for the transformation steps.- Parameters:
settings
- (undocumented)context
- (undocumented)- Returns:
- (undocumented)
-
create
public static ActorMaterializer create(ActorMaterializerSettings settings, ActorRefFactory context, java.lang.String namePrefix)
Java API: Creates an ActorMaterializer that can materialize stream blueprints as running streams.The required
ActorRefFactory
(which can be either anActorSystem
or anActorContext
) will be used to create these actors, therefore it is *forbidden* to pass this object to another actor if the factory is an ActorContext.The
namePrefix
is used as the first part of the names of the actors running the processing steps. The defaultnamePrefix
is"flow"
. The actor names are built up ofnamePrefix-flowNumber-flowStepNumber-stepName
.- Parameters:
settings
- (undocumented)context
- (undocumented)namePrefix
- (undocumented)- Returns:
- (undocumented)
-
settings
public abstract ActorMaterializerSettings settings()
-
shutdown
public abstract void shutdown()
Shuts down this materializer and all the operators that have been materialized through this materializer. After having shut down, this materializer cannot be used again. Any attempt to materialize operators after having shut down will result in an IllegalStateException being thrown at materialization time.
-
isShutdown
public abstract boolean isShutdown()
Indicates if the materializer has been shut down.- Returns:
- (undocumented)
-
actorOf
public abstract ActorRef actorOf(MaterializationContext context, Props props)
INTERNAL API- Parameters:
context
- (undocumented)props
- (undocumented)- Returns:
- (undocumented)
-
system
public abstract ActorSystem system()
INTERNAL API- Returns:
- (undocumented)
-
logger
public abstract LoggingAdapter logger()
INTERNAL API- Returns:
- (undocumented)
-
supervisor
public abstract ActorRef supervisor()
INTERNAL API- Returns:
- (undocumented)
-
-