Package akka.stream

Class ActorMaterializer

    • Constructor Detail

      • ActorMaterializer

        public ActorMaterializer()
    • Method Detail

      • apply

        public static ActorMaterializer apply​(scala.Option<ActorMaterializerSettings> materializerSettings,
                                              scala.Option<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 an ActorSystem or an ActorContext) will be used to create one actor that in turn creates actors for the transformation steps.

        The materializer's ActorMaterializerSettings will be obtained from the configuration of the context's underlying ActorSystem.

        The namePrefix is used as the first part of the names of the actors running the processing steps. The default namePrefix is "flow". The actor names are built up of namePrefix-flowNumber-flowStepNumber-stepName.

        Parameters:
        materializerSettings - (undocumented)
        namePrefix - (undocumented)
        context - (undocumented)
        Returns:
        (undocumented)
      • 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 an ActorSystem or an ActorContext) 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 default namePrefix is "flow". The actor names are built up of namePrefix-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 an ActorSystem or an ActorContext) 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 default namePrefix is "flow". The actor names are built up of namePrefix-flowNumber-flowStepNumber-stepName.

        Parameters:
        materializerSettings - (undocumented)
        context - (undocumented)
        Returns:
        (undocumented)
      • 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 the StreamSupervisor 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 an ActorSystem or an ActorContext) 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 of namePrefix-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 an ActorSystem or an ActorContext) 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 an ActorSystem or an ActorContext) 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 default namePrefix is "flow". The actor names are built up of namePrefix-flowNumber-flowStepNumber-stepName.

        Parameters:
        settings - (undocumented)
        context - (undocumented)
        namePrefix - (undocumented)
        Returns:
        (undocumented)
      • withNamePrefix

        public abstract static Materializer withNamePrefix​(java.lang.String name)
      • materialize

        public abstract static <Mat> Mat materialize​(Graph<ClosedShape,​Mat> runnable)
      • materialize

        public abstract static <Mat> Mat materialize​(Graph<ClosedShape,​Mat> runnable,
                                                     Attributes defaultAttributes)
      • executionContext

        public abstract static scala.concurrent.ExecutionContextExecutor executionContext()
      • scheduleOnce

        public abstract static Cancellable scheduleOnce​(scala.concurrent.duration.FiniteDuration delay,
                                                        java.lang.Runnable task)
      • schedulePeriodically

        public abstract static Cancellable schedulePeriodically​(scala.concurrent.duration.FiniteDuration initialDelay,
                                                                scala.concurrent.duration.FiniteDuration interval,
                                                                java.lang.Runnable task)
      • makeLogger

        public abstract static LoggingAdapter makeLogger​(java.lang.Class<?> logSource)
      • 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)