Class ActorMaterializerSettings

This class describes the configurable properties of the ActorMaterializer. Please refer to the withX methods for descriptions of the individual settings.

Inheritance

object

ActorMaterializerSettings

Inherited Members

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Streams

Assembly: Akka.Streams.dll

Syntax

public sealed class ActorMaterializerSettings

Constructors

ActorMaterializerSettings(int, int, string, Decider, StreamSubscriptionTimeoutSettings, StreamRefSettings, bool, int, bool, bool, int, int)

Declaration

public ActorMaterializerSettings(int initialInputBufferSize, int maxInputBufferSize, string dispatcher, Decider supervisionDecider, StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings, StreamRefSettings streamRefSettings, bool isDebugLogging, int outputBurstLimit, bool isFuzzingMode, bool isAutoFusing, int maxFixedBufferSize, int syncProcessingLimit = 1000)

Parameters

Type	Name	Description
int	initialInputBufferSize
int	maxInputBufferSize
string	dispatcher
Decider	supervisionDecider
StreamSubscriptionTimeoutSettings	subscriptionTimeoutSettings
StreamRefSettings	streamRefSettings
bool	isDebugLogging
int	outputBurstLimit
bool	isFuzzingMode
bool	isAutoFusing
int	maxFixedBufferSize
int	syncProcessingLimit

Fields

Dispatcher

TBD

Declaration

public readonly string Dispatcher

Field Value

Type	Description
string

InitialInputBufferSize

TBD

Declaration

public readonly int InitialInputBufferSize

Field Value

Type	Description
int

IsAutoFusing

TBD

Declaration

public readonly bool IsAutoFusing

Field Value

Type	Description
bool

IsDebugLogging

TBD

Declaration

public readonly bool IsDebugLogging

Field Value

Type	Description
bool

IsFuzzingMode

TBD

Declaration

public readonly bool IsFuzzingMode

Field Value

Type	Description
bool

MaxFixedBufferSize

TBD

Declaration

public readonly int MaxFixedBufferSize

Field Value

Type	Description
int

MaxInputBufferSize

TBD

Declaration

public readonly int MaxInputBufferSize

Field Value

Type	Description
int

OutputBurstLimit

TBD

Declaration

public readonly int OutputBurstLimit

Field Value

Type	Description
int

StreamRefSettings

INTERNAL API

Declaration

public readonly StreamRefSettings StreamRefSettings

Field Value

Type	Description
StreamRefSettings

SubscriptionTimeoutSettings

TBD

Declaration

public readonly StreamSubscriptionTimeoutSettings SubscriptionTimeoutSettings

Field Value

Type	Description
StreamSubscriptionTimeoutSettings

SupervisionDecider

TBD

Declaration

public readonly Decider SupervisionDecider

Field Value

Type	Description
Decider

SyncProcessingLimit

TBD

Declaration

public readonly int SyncProcessingLimit

Field Value

Type	Description
int

Methods

Create(ActorSystem)

Declaration

public static ActorMaterializerSettings Create(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system

Returns

Type	Description
ActorMaterializerSettings

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

WithAutoFusing(bool)

TBD

Declaration

public ActorMaterializerSettings WithAutoFusing(bool isAutoFusing)

Parameters

Type	Name	Description
bool	isAutoFusing	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithDebugLogging(bool)

Enable to log all elements that are dropped due to failures (at DEBUG level).

Declaration

public ActorMaterializerSettings WithDebugLogging(bool isEnabled)

Parameters

Type	Name	Description
bool	isEnabled	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithDispatcher(string)

This setting configures the default dispatcher to be used by streams materialized with the ActorMaterializer. This can be overridden for individual parts of the stream topology by using ActorAttributes.Dispatcher.

Declaration

public ActorMaterializerSettings WithDispatcher(string dispatcher)

Parameters

Type	Name	Description
string	dispatcher	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithFuzzingMode(bool)

Test utility: fuzzing mode means that GraphStage events are not processed in FIFO order within a fused subgraph, but randomized.

Declaration

public ActorMaterializerSettings WithFuzzingMode(bool isFuzzingMode)

Parameters

Type	Name	Description
bool	isFuzzingMode	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithInputBuffer(int, int)

Each asynchronous piece of a materialized stream topology is executed by one Actor that manages an input buffer for all inlets of its shape. This setting configures the default for initial and maximal input buffer in number of elements for each inlet. This can be overridden for individual parts of the stream topology by using Attributes.InputBuffer.

Declaration

public ActorMaterializerSettings WithInputBuffer(int initialSize, int maxSize)

Parameters

Type	Name	Description
int	initialSize	TBD
int	maxSize	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithMaxFixedBufferSize(int)

Configure the maximum buffer size for which a FixedSizeBuffer will be preallocated. This defaults to a large value because it is usually better to fail early when system memory is not sufficient to hold the buffer.

Declaration

public ActorMaterializerSettings WithMaxFixedBufferSize(int maxFixedBufferSize)

Parameters

Type	Name	Description
int	maxFixedBufferSize	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithOutputBurstLimit(int)

Maximum number of elements emitted in batch if downstream signals large demand.

Declaration

public ActorMaterializerSettings WithOutputBurstLimit(int limit)

Parameters

Type	Name	Description
int	limit

Returns

Type	Description
ActorMaterializerSettings

WithStreamRefSettings(StreamRefSettings)

Declaration

public ActorMaterializerSettings WithStreamRefSettings(StreamRefSettings settings)

Parameters

Type	Name	Description
StreamRefSettings	settings

Returns

Type	Description
ActorMaterializerSettings

WithSubscriptionTimeoutSettings(StreamSubscriptionTimeoutSettings)

Leaked publishers and subscribers are cleaned up when they are not used within a given deadline, configured by StreamSubscriptionTimeoutSettings.

Declaration

public ActorMaterializerSettings WithSubscriptionTimeoutSettings(StreamSubscriptionTimeoutSettings settings)

Parameters

Type	Name	Description
StreamSubscriptionTimeoutSettings	settings	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithSupervisionStrategy(Decider)

Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with ActorAttributes.SupervisionStrategy

Declaration

public ActorMaterializerSettings WithSupervisionStrategy(Decider decider)

Parameters

Type	Name	Description
Decider	decider	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

WithSyncProcessingLimit(int)

Limit for number of messages that can be processed synchronously in stream to substream communication

Declaration

public ActorMaterializerSettings WithSyncProcessingLimit(int limit)

Parameters

Type	Name	Description
int	limit	TBD

Returns

Type	Description
ActorMaterializerSettings	TBD

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)