Package org.apache.pekko.stream

Class ActorAttributes

java.lang.Object

org.apache.pekko.stream.ActorAttributes

public class ActorAttributes
extends Object

Attributes for the Materializer. Note that more attributes defined in Attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ActorAttributes.DebugLogging	Enables additional low level troubleshooting logging at DEBUG log level
static class	ActorAttributes.DebugLogging$
static final class	ActorAttributes.Dispatcher	Configures the dispatcher to be used by streams.
static class	ActorAttributes.Dispatcher$
static final class	ActorAttributes.FuzzingMode	Test utility: fuzzing mode means that GraphStage events are not processed in FIFO order within a fused subgraph, but randomized.
static class	ActorAttributes.FuzzingMode$
static final class	ActorAttributes.MaxFixedBufferSize	Configure the maximum buffer size for which a FixedSizeBuffer will be preallocated.
static class	ActorAttributes.MaxFixedBufferSize$
static final class	ActorAttributes.OutputBurstLimit	Maximum number of elements emitted in batch if downstream signals large demand.
static class	ActorAttributes.OutputBurstLimit$
static final class	ActorAttributes.StreamSubscriptionTimeout	Defines a timeout for stream subscription and what action to take when that hits.
static class	ActorAttributes.StreamSubscriptionTimeout$
static final class	ActorAttributes.SupervisionStrategy
static class	ActorAttributes.SupervisionStrategy$
static final class	ActorAttributes.SyncProcessingLimit	Limit for number of messages that can be processed synchronously in stream to substream communication.
static class	ActorAttributes.SyncProcessingLimit$

Constructor Summary

Constructors

Constructor	Description
ActorAttributes()

Method Summary

Modifier and Type	Method	Description
static Attributes	createLogLevels(Logging.LogLevel onElement)	Java API
static Attributes	createLogLevels(Logging.LogLevel onElement, Logging.LogLevel onFinish, Logging.LogLevel onFailure)	Java API
static Attributes	debugLogging(boolean enabled)	Enables additional low level troubleshooting logging at DEBUG log level
static Attributes	dispatcher(String dispatcher)	Specifies the name of the dispatcher.
static Attributes	fuzzingMode(boolean enabled)	Test utility: fuzzing mode means that GraphStage events are not processed in FIFO order within a fused subgraph, but randomized.
static ActorAttributes.Dispatcher	IODispatcher()
static Attributes	logLevels(Logging.LogLevel onElement, Logging.LogLevel onFinish, Logging.LogLevel onFailure)	Configures log() operator log-levels to be used when logging.
static Logging.LogLevel	logLevels$default$1()
static Logging.LogLevel	logLevels$default$2()
static Logging.LogLevel	logLevels$default$3()
static Attributes	maxFixedBufferSize(int size)	Configure the maximum buffer size for which a FixedSizeBuffer will be preallocated.
static Attributes	outputBurstLimit(int limit)	Maximum number of elements emitted in batch if downstream signals large demand.
static Attributes	streamSubscriptionTimeout(Duration timeout, StreamSubscriptionTimeoutTerminationMode mode)	Java API: Defines a timeout for stream subscription and what action to take when that hits.
static Attributes	streamSubscriptionTimeout(scala.concurrent.duration.FiniteDuration timeout, StreamSubscriptionTimeoutTerminationMode mode)	Scala API: Defines a timeout for stream subscription and what action to take when that hits.
static Attributes	supervisionStrategy(scala.Function1<Throwable,Supervision.Directive> decider)	Scala API: Decides how exceptions from user are to be handled.
static Attributes	syncProcessingLimit(int limit)	Limit for number of messages that can be processed synchronously in stream to substream communication
static Attributes	withSupervisionStrategy(Function<Throwable,Supervision.Directive> decider)	Java API: Decides how exceptions from application code are to be handled.

Methods inherited from class java.lang.Object

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

Constructor Details

ActorAttributes

public ActorAttributes()

Method Details

IODispatcher

public static ActorAttributes.Dispatcher IODispatcher()

dispatcher

public static Attributes dispatcher(String dispatcher)

Specifies the name of the dispatcher. This also adds an async boundary.

supervisionStrategy

public static Attributes supervisionStrategy(scala.Function1<Throwable,Supervision.Directive> decider)

Scala API: Decides how exceptions from user are to be handled.

Operators supporting supervision strategies explicitly document that they do so. If a operator does not document support for these, it should be assumed it does not support supervision.

For the Java API see withSupervisionStrategy(org.apache.pekko.japi.function.Function<java.lang.Throwable, org.apache.pekko.stream.Supervision.Directive>)

withSupervisionStrategy

public static Attributes withSupervisionStrategy(Function<Throwable,Supervision.Directive> decider)

Java API: Decides how exceptions from application code are to be handled.

Operators supporting supervision strategies explicitly document that they do so. If a operator does not document support for these, it should be assumed it does not support supervision.

For the Scala API see supervisionStrategy(scala.Function1<java.lang.Throwable, org.apache.pekko.stream.Supervision.Directive>)

createLogLevels

public static Attributes createLogLevels(Logging.LogLevel onElement,
 Logging.LogLevel onFinish,
 Logging.LogLevel onFailure)

Java API

Configures log() operator log-levels to be used when logging. Logging a certain operation can be completely disabled by using Attributes.logLevelOff().

createLogLevels

public static Attributes createLogLevels(Logging.LogLevel onElement)

Java API

Configures log() operator log-levels to be used when logging onElement. Logging a certain operation can be completely disabled by using Attributes.logLevelOff().

logLevels

public static Attributes logLevels(Logging.LogLevel onElement,
 Logging.LogLevel onFinish,
 Logging.LogLevel onFailure)

Configures log() operator log-levels to be used when logging. Logging a certain operation can be completely disabled by using LogLevels.Off.

See Attributes.createLogLevels for Java API

logLevels$default$1

public static Logging.LogLevel logLevels$default$1()

logLevels$default$2

public static Logging.LogLevel logLevels$default$2()

logLevels$default$3

public static Logging.LogLevel logLevels$default$3()

debugLogging

public static Attributes debugLogging(boolean enabled)

Enables additional low level troubleshooting logging at DEBUG log level

streamSubscriptionTimeout

public static Attributes streamSubscriptionTimeout(scala.concurrent.duration.FiniteDuration timeout,
 StreamSubscriptionTimeoutTerminationMode mode)

Scala API: Defines a timeout for stream subscription and what action to take when that hits.

streamSubscriptionTimeout

public static Attributes streamSubscriptionTimeout(Duration timeout,
 StreamSubscriptionTimeoutTerminationMode mode)

Java API: Defines a timeout for stream subscription and what action to take when that hits.

outputBurstLimit

public static Attributes outputBurstLimit(int limit)

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

fuzzingMode

public static Attributes fuzzingMode(boolean enabled)

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

maxFixedBufferSize

public static Attributes maxFixedBufferSize(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.

syncProcessingLimit

public static Attributes syncProcessingLimit(int limit)

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