org.apache.pekko

Members list

Packages

== Commonly Used Patterns With Pekko ==

This package is used as a collection point for usage patterns which involve actors, futures, etc. but are loosely enough coupled to (multiple of) them to present them separately from the core implementation. Currently supported are:

ask: create a temporary one-off actor for receiving a reply to a message and complete a scala.concurrent.Future with it; returns said Future.
pipeTo: feed eventually computed value of a future to a org.apache.pekko.actor.ActorRef as a message.
pipeToSelection: feed eventually computed value of a future to a org.apache.pekko.actor.ActorSelection as a message.

In Scala the recommended usage is to import the pattern from the package object:

import org.apache.pekko.pattern.ask

ask(actor, message) // use it directly
actor ask message   // use it by implicit conversion

For Java the patterns are available as static methods of the org.apache.pekko.pattern.Patterns class:

import static org.apache.pekko.pattern.Patterns.ask;

ask(actor, message);

Attributes

Type members

Classlikes

This exception is thrown when Apache Pekko detects a problem with the provided configuration

Attributes

Source: PekkoException.scala
Supertypes: class PekkoException

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

@DoNotInherit

Typically used together with Future to signal completion but there is no actual value completed. More clearly signals intent than Unit and is available both from Scala and Java (which Unit is not).

Attributes

Companion: object
Source: Done.scala
Supertypes: trait Serializable

class Object

trait Matchable

class Any
Known subtypes: object Done

Attributes

Companion: class
Source: Done.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Product

trait Equals

class Done

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Done.type

This type is used in generic type signatures wherever the actual value is of no importance. It is a combination of Scala’s Unit and Java’s Void, which both have different issues when used from the other language. An example use-case is the materialized value of a Pekko Stream for cases where no result shall be returned from materialization.

Attributes

Companion: object
Source: NotUsed.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object NotUsed

Attributes

Companion: class
Source: NotUsed.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class NotUsed

class Object

trait Matchable

class Any
Show all
Self type: NotUsed.type

Mix in this trait to suppress the StackTrace for the instance of the exception but not the cause, scala.util.control.NoStackTrace suppresses all the StackTraces.

Attributes

Source: PekkoException.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Throwable

Pekko base Exception.

Attributes

Source: PekkoException.scala
Supertypes: class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all
Known subtypes: class SerializationCheckFailedException

class ActorInitializationException

class PostRestartException

class PreRestartException

class ActorInterruptedException

class ActorKilledException

class DeathPactException

class IllegalActorStateException

class InvalidActorNameException

class InvalidMessageException

class StashOverflowException

class LoggerException

class LoggerInitializationException

class CircuitBreakerOpenException

class ResizerInitializationException

class ConfigurationException
Show all

Attributes

Source: PekkoVersion.scala
Supertypes: class Object

trait Matchable

class Any
Self type: PekkoVersion.type

Attributes

Source: PekkoVersion.scala
Supertypes: class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Source: Version.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Version.type

In this article

Generated with