Class ActorMaterializer

A ActorMaterializer takes the list of transformations comprising a IFlow<TOut, TMat> and materializes them in the form of Reactive.Streams.IProcessor<T1, T2> instances. How transformation steps are split up into asynchronous regions is implementation dependent.

Inheritance

object

ActorMaterializer

ExtendedActorMaterializer

Implements

IMaterializer

IMaterializerLoggingProvider

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Streams

Assembly: Akka.Streams.dll

Syntax

public abstract class ActorMaterializer : IMaterializer, IMaterializerLoggingProvider, IDisposable

Properties

ExecutionContext

TBD

Declaration

public abstract MessageDispatcher ExecutionContext { get; }

Property Value

Type	Description
MessageDispatcher

IsShutdown

Indicates if the materializer has been shut down.

Declaration

public abstract bool IsShutdown { get; }

Property Value

Type	Description
bool

Logger

TBD

Declaration

public abstract ILoggingAdapter Logger { get; }

Property Value

Type	Description
ILoggingAdapter

Settings

TBD

Declaration

public abstract ActorMaterializerSettings Settings { get; }

Property Value

Type	Description
ActorMaterializerSettings

Supervisor

TBD

Declaration

public abstract IActorRef Supervisor { get; }

Property Value

Type	Description
IActorRef

System

TBD

Declaration

public abstract ActorSystem System { get; }

Property Value

Type	Description
ActorSystem

Methods

ActorOf(MaterializationContext, Props)

TBD

Declaration

public abstract IActorRef ActorOf(MaterializationContext context, Props props)

Parameters

Type	Name	Description
MaterializationContext	context	TBD
Props	props	TBD

Returns

Type	Description
IActorRef	TBD

Create(IActorRefFactory, ActorMaterializerSettings, string)

Creates a ActorMaterializer which will execute every step of a transformation pipeline within its own ActorBase. The required IActorRefFactory (which can be either an ActorSystem or an IActorContext) 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`.

Declaration

public static ActorMaterializer Create(IActorRefFactory context, ActorMaterializerSettings settings = null, string namePrefix = null)

Parameters

Type	Name	Description
IActorRefFactory	context	TBD
ActorMaterializerSettings	settings	TBD
string	namePrefix	TBD

Returns

Type	Description
ActorMaterializer	TBD

Exceptions

Type	Condition
ArgumentException	This exception is thrown when the specified context is not of type ActorSystem or IActorContext.
ArgumentNullException	This exception is thrown when the specified context is undefined.

DefaultConfig()

TBD

Declaration

public static Config DefaultConfig()

Returns

Type	Description
Config	TBD

Dispose()

Declaration

public void Dispose()

EffectiveSettings(Attributes)

TBD

Declaration

public abstract ActorMaterializerSettings EffectiveSettings(Attributes attributes)

Parameters

Type	Name	Description
Attributes	attributes	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

MakeLogger(object)

Creates a new logging adapter.

Declaration

public abstract ILoggingAdapter MakeLogger(object logSource)

Parameters

Type	Name	Description
object	logSource	The source that produces the log events.

Returns

Type	Description
ILoggingAdapter	The newly created logging adapter.

Materialize<TMat>(IGraph<ClosedShape, TMat>)

This method interprets the given Flow description and creates the running stream. The result can be highly implementation specific, ranging from local actor chains to remote-deployed processing networks.

Declaration

public abstract TMat Materialize<TMat>(IGraph<ClosedShape, TMat> runnable)

Parameters

Type	Name	Description
IGraph<ClosedShape, TMat>	runnable	The flow that should be materialized.

Returns

Type	Description
TMat	The materialized value

Type Parameters

Name	Description
TMat	The type of the materialized value

Materialize<TMat>(IGraph<ClosedShape, TMat>, Attributes)

This method interprets the given Flow description and creates the running stream using an explicitly provided Attributes as top level attributes. stream. The result can be highly implementation specific, ranging from local actor chains to remote-deployed processing networks.

Declaration

public abstract TMat Materialize<TMat>(IGraph<ClosedShape, TMat> runnable, Attributes initialAttributes)

Parameters

Type	Name	Description
IGraph<ClosedShape, TMat>	runnable	The flow that should be materialized.
Attributes	initialAttributes	The initialAttributes for this materialization

Returns

Type	Description
TMat	The materialized value

Type Parameters

Name	Description
TMat	The type of the materialized value

ScheduleOnce(TimeSpan, Action)

TBD

Declaration

public abstract ICancelable ScheduleOnce(TimeSpan delay, Action action)

Parameters

Type	Name	Description
TimeSpan	delay	TBD
Action	action	TBD

Returns

Type	Description
ICancelable	TBD

ScheduleRepeatedly(TimeSpan, TimeSpan, Action)

TBD

Declaration

public abstract ICancelable ScheduleRepeatedly(TimeSpan initialDelay, TimeSpan interval, Action action)

Parameters

Type	Name	Description
TimeSpan	initialDelay	TBD
TimeSpan	interval	TBD
Action	action	TBD

Returns

Type	Description
ICancelable	TBD

Shutdown()

Shuts down this materializer and all the stages that have been materialized through this materializer. After having shut down, this materializer cannot be used again. Any attempt to materialize stages after having shut down will result in an IllegalStateException being thrown at materialization time.

Declaration

public abstract void Shutdown()

WithNamePrefix(string)

TBD

Declaration

public abstract IMaterializer WithNamePrefix(string namePrefix)

Parameters

Type	Name	Description
string	namePrefix	TBD

Returns

Type	Description
IMaterializer	TBD

Implements

IMaterializer

IMaterializerLoggingProvider

IDisposable

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)