TypedActor

TypedActor base trait that should be extended by to create a typed Actor. This actor is designed to only receive one type of message in its lifetime. Typically, this is some ADT/sealed trait that defines the protocol for this actor.

The message type is defined by extending TypedActor.Of:

class ExampleActor extends TypeActor.Of[ExampleProtocol] {
  // ...
}

The TypedActor is just a regular actor, but if offers some methods that help you stay within the defined typed contract. TypedActor#typedSelf is the alternative to akka.actor.Actor.self to get the typed ActorRef for this actor. TypedActor#typedBecome is the alternative to context.become to check the receiving type while changing behavior. You can get exhausitveness checking for your receive block if you use TypedActor#Total as a wrapper around your receive block.

// error: match may not be exhaustive. It would fail on the following inputs: None
class ExampleActor extends TypedActor {
  type Message = Option[String]
  def typedReceive: TypedReceive = Total {
    case Some("foo") ⇒
  }
}

If you must go back to untyped land, use the TypedActor#Untyped wrapper.

See also: akka.actor.Actor for more about Actors in general.

Linear Supertypes

Actor, AnyRef, Any

Known Subclasses

Type Members

abstract type Message
type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor
final type TypedReceive = PartialFunction[Message, Unit]

Abstract Value Members

abstract def typedReceive: TypedReceive

Defines the actors behavior.
Defines the actors behavior. Unlike akka.actor.Actor#receive, this one is typed in its first parameter.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def Total(f: (Message) ⇒ Unit)(implicit ct: ClassTag[Message]): TypedReceive

Wraps a total receiver function and returns it as a TypedReceive.
Wraps a total receiver function and returns it as a TypedReceive. Use this to get exhaustiveness checking for your receive block.
```
// error: match may not be exhaustive. It would fail on the following inputs: None
class ExampleActor extends TypedActor.Of[Option[String]] {
  def typedReceive: TypedReceive = Total {
    case Some("foo") ⇒
  }
}
```
final def TotalUnion(implicit ev: IsUnion[Message]): MkTotalUnionReceiveEmpty[Out]

Builds final receive out of sub-receives if this TypedActor is for a Union message type.
Builds final receive out of sub-receives if this TypedActor is for a Union message type. This mirrors a Total receive, i.e. you must provide all cases.
```
class ExampleActor extends TypedActor.Of[Foo | Bar | Baz] {
  def typedReceive: TypedReceive = TotalUnion
    .on[Foo]{ case Foo() => println("foo") }
    .on[Bar]{ case Bar() => println("bar") }
    .on[Bax]{ case Bax() => println("bax") }
    .apply
  }
}
```
final def Union(implicit ev: IsUnion[Message]): MkPartialUnionReceive[Out, Empty]

Builds final receive out of sub-receives if this TypedActor is for a Union message type.
Builds final receive out of sub-receives if this TypedActor is for a Union message type. This mirrors a TypedReceive, i.e. you must not cover all cases.
```
class ExampleActor extends TypedActor.Of[Foo | Bar | Baz] {
  def typedReceive: TypedReceive = Union
    .on[Foo]{ case Foo() => println("foo") }
    .on[Bar]{ case Bar() => println("bar") }
    .apply
  }
}
```
final def Untyped(f: Receive): TypedReceive

Wraps an untyped receiver and returns it as a TypedReceive.
Wraps an untyped receiver and returns it as a TypedReceive. Use this to match for messages that are outside of your protocol, e.g. akka.actor.Terminated.
```
class ExampleActor extends TypedActor.Of[ExampleMessage] {
  def typedReceive: TypedReceive = Untyped {
    case Terminated(ref) => println(s"$$ref terminated")
  }
}
```
def aroundPostRestart(reason: Throwable): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundPostStop(): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundPreStart(): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
Actor
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit val context: ActorContext

Definition Classes
Actor
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postRestart(reason: Throwable): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def postStop(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preRestart(reason: Throwable, message: Option[Any]): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preStart(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def receive: Receive

TypedActors delegate to typedReceive.
TypedActors delegate to typedReceive.

Definition Classes
TypedActor → Actor
See also
akka.actor.Actor#receive
implicit final val self: akka.actor.ActorRef

Definition Classes
Actor
final def sender(): akka.actor.ActorRef

Definition Classes
Actor
def supervisorStrategy: SupervisorStrategy

Definition Classes
Actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def typedBecome(f: TypedReceive): Unit

Typed variant of context.become.
final val typedSelf: ActorRef[Message]

Typed variant of self.
def unhandled(message: Any): Unit

Definition Classes
Actor
final def unionBecome(implicit ev: IsUnion[Message]): TypedBecomeOnAux[Out]

context.become for a given subtype if this actor is of a union type.
final def untypedFromTyped(f: TypedReceive): Receive

Wraps a typed receive and returns it as an untyped receive.
Wraps a typed receive and returns it as an untyped receive. Use this only if you have to mix with other traits that override receive, where you need to repeat the implementation of this typed actors default receive method.

Attributes
protected
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object TypedActor | package typed

trait TypedActor extends Actor

Type Members

abstract type Message

type Receive = PartialFunction[Any, Unit]

final type TypedReceive = PartialFunction[Message, Unit]

Abstract Value Members

abstract def typedReceive: TypedReceive

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def Total(f: (Message) ⇒ Unit)(implicit ct: ClassTag[Message]): TypedReceive

final def TotalUnion(implicit ev: IsUnion[Message]): MkTotalUnionReceiveEmpty[Out]

final def Union(implicit ev: IsUnion[Message]): MkPartialUnionReceive[Out, Empty]

final def Untyped(f: Receive): TypedReceive

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit val context: ActorContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def receive: Receive

implicit final val self: akka.actor.ActorRef

final def sender(): akka.actor.ActorRef

def supervisorStrategy: SupervisorStrategy

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def typedBecome(f: TypedReceive): Unit

final val typedSelf: ActorRef[Message]

def unhandled(message: Any): Unit

final def unionBecome(implicit ev: IsUnion[Message]): TypedBecomeOnAux[Out]

final def untypedFromTyped(f: TypedReceive): Receive

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped