akka.stream

Class ActorMaterializerSettings

java.lang.Object

akka.stream.ActorMaterializerSettings

public final class ActorMaterializerSettings
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
ActorMaterializerSettings(int initialInputBufferSize, int maxInputBufferSize, java.lang.String dispatcher, scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider, StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings, boolean debugLogging, int outputBurstLimit, boolean fuzzingMode, boolean autoFusing, int maxFixedBufferSize)

Method Summary

Modifier and Type	Method and Description
static ActorMaterializerSettings	apply(ActorSystem system) Create ActorMaterializerSettings from the settings of an ActorSystem (Scala).
static ActorMaterializerSettings	apply(com.typesafe.config.Config config) Create ActorMaterializerSettings from a Config subsection (Scala).
static ActorMaterializerSettings	apply(int initialInputBufferSize, int maxInputBufferSize, java.lang.String dispatcher, scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider, StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings, boolean debugLogging, int outputBurstLimit, boolean fuzzingMode, boolean autoFusing, int maxFixedBufferSize) Create ActorMaterializerSettings from individual settings (Scala).
boolean	autoFusing()
static ActorMaterializerSettings	create(ActorSystem system) Create ActorMaterializerSettings from the settings of an ActorSystem (Java).
static ActorMaterializerSettings	create(com.typesafe.config.Config config) Create ActorMaterializerSettings from a Config subsection (Java).
static ActorMaterializerSettings	create(int initialInputBufferSize, int maxInputBufferSize, java.lang.String dispatcher, scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider, StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings, boolean debugLogging, int outputBurstLimit, boolean fuzzingMode, boolean autoFusing, int maxFixedBufferSize) Create ActorMaterializerSettings from individual settings (Java).
boolean	debugLogging()
java.lang.String	dispatcher()
boolean	equals(java.lang.Object other)
boolean	fuzzingMode()
int	initialInputBufferSize()
int	maxFixedBufferSize()
int	maxInputBufferSize()
int	outputBurstLimit()
StreamSubscriptionTimeoutSettings	subscriptionTimeoutSettings()
scala.Function1<java.lang.Throwable,Supervision.Directive>	supervisionDecider()
int	syncProcessingLimit()
java.lang.String	toString()
ActorMaterializerSettings	withAutoFusing(boolean enable) Enable automatic fusing of all graphs that are run.
ActorMaterializerSettings	withDebugLogging(boolean enable) Enable to log all elements that are dropped due to failures (at DEBUG level).
ActorMaterializerSettings	withDispatcher(java.lang.String dispatcher) This setting configures the default dispatcher to be used by streams materialized with the ActorMaterializer.
ActorMaterializerSettings	withFuzzing(boolean enable) Test utility: fuzzing mode means that GraphStage events are not processed in FIFO order within a fused subgraph, but randomized.
ActorMaterializerSettings	withInputBuffer(int initialSize, int maxSize) Each asynchronous piece of a materialized stream topology is executed by one Actor that manages an input buffer for all inlets of its shape.
ActorMaterializerSettings	withMaxFixedBufferSize(int size) Configure the maximum buffer size for which a FixedSizeBuffer will be preallocated.
ActorMaterializerSettings	withOutputBurstLimit(int limit) Maximum number of elements emitted in batch if downstream signals large demand.
ActorMaterializerSettings	withSubscriptionTimeoutSettings(StreamSubscriptionTimeoutSettings settings) Leaked publishers and subscribers are cleaned up when they are not used within a given deadline, configured by StreamSubscriptionTimeoutSettings.
ActorMaterializerSettings	withSupervisionStrategy(Function<java.lang.Throwable,Supervision.Directive> decider) Java API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.
ActorMaterializerSettings	withSupervisionStrategy(scala.Function1<java.lang.Throwable,Supervision.Directive> decider) Scala API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.
ActorMaterializerSettings	withSyncProcessingLimit(int limit) Limit for number of messages that can be processed synchronously in stream to substream communication

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ActorMaterializerSettings

public ActorMaterializerSettings(int initialInputBufferSize,
                                 int maxInputBufferSize,
                                 java.lang.String dispatcher,
                                 scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider,
                                 StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings,
                                 boolean debugLogging,
                                 int outputBurstLimit,
                                 boolean fuzzingMode,
                                 boolean autoFusing,
                                 int maxFixedBufferSize)

Method Detail

apply

public static ActorMaterializerSettings apply(int initialInputBufferSize,
                                              int maxInputBufferSize,
                                              java.lang.String dispatcher,
                                              scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider,
                                              StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings,
                                              boolean debugLogging,
                                              int outputBurstLimit,
                                              boolean fuzzingMode,
                                              boolean autoFusing,
                                              int maxFixedBufferSize)

Create ActorMaterializerSettings from individual settings (Scala).

Parameters:

initialInputBufferSize - (undocumented)

maxInputBufferSize - (undocumented)

dispatcher - (undocumented)

supervisionDecider - (undocumented)

subscriptionTimeoutSettings - (undocumented)

debugLogging - (undocumented)

outputBurstLimit - (undocumented)

fuzzingMode - (undocumented)

autoFusing - (undocumented)

maxFixedBufferSize - (undocumented)

Returns:

(undocumented)

apply

public static ActorMaterializerSettings apply(ActorSystem system)

Create ActorMaterializerSettings from the settings of an ActorSystem (Scala).

Parameters:

system - (undocumented)

Returns:

(undocumented)

apply

public static ActorMaterializerSettings apply(com.typesafe.config.Config config)

Create ActorMaterializerSettings from a Config subsection (Scala).

Parameters:

config - (undocumented)

Returns:

(undocumented)

create

public static ActorMaterializerSettings create(int initialInputBufferSize,
                                               int maxInputBufferSize,
                                               java.lang.String dispatcher,
                                               scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider,
                                               StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings,
                                               boolean debugLogging,
                                               int outputBurstLimit,
                                               boolean fuzzingMode,
                                               boolean autoFusing,
                                               int maxFixedBufferSize)

Create ActorMaterializerSettings from individual settings (Java).

Parameters:

initialInputBufferSize - (undocumented)

maxInputBufferSize - (undocumented)

dispatcher - (undocumented)

supervisionDecider - (undocumented)

subscriptionTimeoutSettings - (undocumented)

debugLogging - (undocumented)

outputBurstLimit - (undocumented)

fuzzingMode - (undocumented)

autoFusing - (undocumented)

maxFixedBufferSize - (undocumented)

Returns:

(undocumented)

create

public static ActorMaterializerSettings create(ActorSystem system)

Create ActorMaterializerSettings from the settings of an ActorSystem (Java).

Parameters:

system - (undocumented)

Returns:

(undocumented)

create

public static ActorMaterializerSettings create(com.typesafe.config.Config config)

Create ActorMaterializerSettings from a Config subsection (Java).

Parameters:

config - (undocumented)

Returns:

(undocumented)

initialInputBufferSize

public int initialInputBufferSize()

maxInputBufferSize

public int maxInputBufferSize()

dispatcher

public java.lang.String dispatcher()

supervisionDecider

public scala.Function1<java.lang.Throwable,Supervision.Directive> supervisionDecider()

subscriptionTimeoutSettings

public StreamSubscriptionTimeoutSettings subscriptionTimeoutSettings()

debugLogging

public boolean debugLogging()

outputBurstLimit

public int outputBurstLimit()

fuzzingMode

public boolean fuzzingMode()

autoFusing

public boolean autoFusing()

maxFixedBufferSize

public int maxFixedBufferSize()

syncProcessingLimit

public int syncProcessingLimit()

withInputBuffer

public ActorMaterializerSettings withInputBuffer(int initialSize,
                                                 int maxSize)

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 initial and maximal input buffer in number of elements for each inlet.

FIXME: Currently only the initialSize is used, auto-tuning is not yet implemented.

Parameters:

initialSize - (undocumented)

maxSize - (undocumented)

Returns:

(undocumented)

withDispatcher

public ActorMaterializerSettings withDispatcher(java.lang.String dispatcher)

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 akka.stream.Attributes#dispatcher.

Parameters:

dispatcher - (undocumented)

Returns:

(undocumented)

withSupervisionStrategy

public ActorMaterializerSettings withSupervisionStrategy(scala.Function1<java.lang.Throwable,Supervision.Directive> decider)

Scala API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.

Parameters:

decider - (undocumented)

Returns:

(undocumented)

withSupervisionStrategy

public ActorMaterializerSettings withSupervisionStrategy(Function<java.lang.Throwable,Supervision.Directive> decider)

Java API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.

Parameters:

decider - (undocumented)

Returns:

(undocumented)

withFuzzing

public ActorMaterializerSettings withFuzzing(boolean enable)

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

Parameters:

enable - (undocumented)

Returns:

(undocumented)

withOutputBurstLimit

public ActorMaterializerSettings withOutputBurstLimit(int limit)

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

Parameters:

limit - (undocumented)

Returns:

(undocumented)

withSyncProcessingLimit

public ActorMaterializerSettings withSyncProcessingLimit(int limit)

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

Parameters:

limit - (undocumented)

Returns:

(undocumented)

withDebugLogging

public ActorMaterializerSettings withDebugLogging(boolean enable)

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

Parameters:

enable - (undocumented)

Returns:

(undocumented)

withAutoFusing

public ActorMaterializerSettings withAutoFusing(boolean enable)

Enable automatic fusing of all graphs that are run. For short-lived streams this may cause an initial runtime overhead, but most of the time fusing is desirable since it reduces the number of Actors that are created.

Parameters:

enable - (undocumented)

Returns:

(undocumented)

withMaxFixedBufferSize

public ActorMaterializerSettings withMaxFixedBufferSize(int size)

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.

Parameters:

size - (undocumented)

Returns:

(undocumented)

withSubscriptionTimeoutSettings

public ActorMaterializerSettings withSubscriptionTimeoutSettings(StreamSubscriptionTimeoutSettings settings)

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

Parameters:

settings - (undocumented)

Returns:

(undocumented)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object