Package

akka

Permalink

package akka

Content Hierarchy

Visibility

Public
All

Type Members

class AkkaException extends RuntimeException with Serializable

Akka base Exception.
Akka base Exception.

Annotations
@SerialVersionUID()
class ConfigurationException extends AkkaException

This exception is thrown when Akka detects a problem with the provided configuration
sealed abstract class Done extends AnyRef

Typically used together with Future to signal completion but there is no actual value completed.
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).
sealed abstract class NotUsed extends AnyRef

This type is used in generic type signatures wherever the actual value is of no importance.
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 an Akka Stream for cases where no result shall be returned from materialization.
trait OnlyCauseStackTrace extends AnyRef

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.

Value Members

object Done extends Done with Product with Serializable
object Main

Main class to start an akka.actor.ActorSystem with one top level application supervisor actor.
Main class to start an akka.actor.ActorSystem with one top level application supervisor actor. It will shutdown the actor system when the top level actor is terminated.
object NotUsed extends NotUsed with Product with Serializable
object Version
package actor
package annotation
package dispatch
package event
package io
package japi
package pattern

This package is used as a collection point for usage patterns which involve actors, futures, etc.
Commonly Used Patterns With Akka
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 an akka.actor.ActorRef as a message.
- pipeToSelection: feed eventually computed value of a future to an akka.actor.ActorSelection as a message.
In Scala the recommended usage is to import the pattern from the package object:
```
import akka.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 akka.pattern.Patterns class:
```
import static akka.pattern.Patterns.ask;

ask(actor, message);
```
package routing
package serialization
package util

Ungrouped