Interface IMaterializer

Materializer SPI (Service Provider Interface)

Custom materializer implementations should be aware that the materializer SPI is not yet final and may change in patch releases of Akka. Please note that this does not impact end-users of Akka streams, only implementors of custom materializers, with whom the Akka.Net team co-ordinates such changes.

Once the SPI is final this notice will be removed.

Namespace: Akka.Streams
Assembly: Akka.Streams.dll
Syntax
public interface IMaterializer

Properties

| Edit this page View Source

ExecutionContext

Running a flow graph will require execution resources, as will computations within Sources, Sinks, etc. This MessageDispatcher can be used by parts of the flow to submit processing jobs for execution, run Future callbacks, etc.

Declaration
MessageDispatcher ExecutionContext { get; }
Property Value
Type Description
MessageDispatcher

Methods

| Edit this page View Source

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
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
| Edit this page View Source

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
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
| Edit this page View Source

ScheduleOnce(TimeSpan, Action)

Interface for stages that need timer services for their functionality. Schedules a single task with the given delay.

Declaration
ICancelable ScheduleOnce(TimeSpan delay, Action action)
Parameters
Type Name Description
TimeSpan delay

TBD
Action action

TBD
Returns
Type Description
ICancelable

A ICancelable that allows cancelling the timer. Cancelling is best effort, if the event has been already enqueued it will not have an effect.
| Edit this page View Source

ScheduleRepeatedly(TimeSpan, TimeSpan, Action)

Interface for stages that need timer services for their functionality. Schedules a repeated task with the given interval between invocations.

Declaration
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

A ICancelable that allows cancelling the timer. Cancelling is best effort, if the event has been already enqueued it will not have an effect.
| Edit this page View Source

WithNamePrefix(string)

The namePrefix shall be used for deriving the names of processing entities that are created during materialization. This is meant to aid logging and failure reporting both during materialization and while the stream is running.

Declaration
IMaterializer WithNamePrefix(string namePrefix)
Parameters
Type Name Description
string namePrefix

TBD
Returns
Type Description
IMaterializer

TBD

Extension Methods