typed

Type Members

type ActorRef[A] = AnyRef { ... /* 2 definitions in type refinement */ }
implicit final class ActorRefOps[A] extends AnyVal
implicit final class ActorRefUnionedOps[U <: Union] extends AnyVal
sealed trait ContainsSomeOf0 extends AnyRef
sealed trait IsPartOf0 extends AnyRef
sealed trait IsUnion[-A] extends AnyRef

Annotations
@implicitNotFound( ... )
type Props[A] = AnyRef { ... /* 2 definitions in type refinement */ }
final class PropsBuilder[A] extends AnyVal

Type-curried creation of Props[A] to aid the type inference.
Type-curried creation of Props[A] to aid the type inference.
A
the message type this actor is receiving

See also
de.knutwalker.akka.typed.PropsOf
implicit final class PropsOps[A] extends AnyVal
trait TypedActor extends Actor

TypedActor base trait that should be extended by to create a typed Actor.
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.
sealed trait Union extends AnyRef
type UntypedActorRef = akka.actor.ActorRef
implicit final class UntypedActorRefOps extends AnyVal
type UntypedProps = akka.actor.Props
implicit final class UntypedPropsOps extends AnyVal
sealed trait containsAllOf[U <: Union, T <: Union] extends AnyRef

Annotations
@implicitNotFound( ... )
sealed trait containsSomeOf[U <: Union, T <: Union] extends AnyRef

Annotations
@implicitNotFound( ... )
sealed trait isNotA[A, B] extends AnyRef
sealed trait isPartOf[A, +U <: Union] extends AnyRef

Annotations
@implicitNotFound( ... )
sealed trait |[+A, +B] extends Union

Value Members

def ActorOf[A](p: Props[A])(implicit factory: ActorRefFactory): ActorRef[A]

Creates a new typed actor as a child of the implicit akka.actor.ActorRefFactory and give it an automatically generated name.
Creates a new typed actor as a child of the implicit akka.actor.ActorRefFactory and give it an automatically generated name.
A
the message type this actor is receiving
p
see Props for details on how to obtain a Props object
factory
the factory to create the actor. Within an actor itself, this is its context. For a toplevel actor, you need to put the ActorSystem into the implicit scope.
returns
the typed ActorRef[A] for this actor

Exceptions thrown
akka.ConfigurationException if deployment, dispatcher or mailbox configuration is wrong
def ActorOf[A](p: Props[A], name: String)(implicit factory: ActorRefFactory): ActorRef[A]

Creates a new typed actor with the given name as a child of the implicit akka.actor.ActorRefFactory.
Creates a new typed actor with the given name as a child of the implicit akka.actor.ActorRefFactory.
A
the message type this actor is receiving
p
see Props for details on how to obtain a Props object
name
the name of the actor. must not be null, empty or start with “$”. If the given name is already in use, an InvalidActorNameException is thrown.
factory
the factory to create the actor. Within an actor itself, this is its context. For a toplevel actor, you need to put the ActorSystem into the implicit scope.
returns
the typed ActorRef[A] for this actor

Exceptions thrown
akka.ConfigurationException if deployment, dispatcher or mailbox configuration is wrong
akka.actor.InvalidActorNameException if the given name is invalid or already in use
object IsUnion
def Props[A](p: UntypedProps): Props[A]

Creates a new typed Props that uses the given akka.actor.Props to create instances of this actor.
Creates a new typed Props that uses the given akka.actor.Props to create instances of this actor.
A
the message type this actor is receiving
p
the Props to use
returns
a typed Props to create ActorRef[A]s for this actor
def Props[A, T <: Actor](clazz: Class[T], args: Any*): Props[A]

Creates a new typed Props that uses the given class and constructor arguments to create instances of this actor.
Creates a new typed Props that uses the given class and constructor arguments to create instances of this actor.
Wrapper for akka.actor.Props[T](Class[T], Any*).
A
the message type this actor is receiving
T
the actor type
clazz
the class of this actor
args
the constructor argumentes of this actor
returns
a typed Props to create ActorRef[A]s for this actor
def Props[A, T <: Actor](creator: ⇒ T)(implicit arg0: ClassTag[T]): Props[A]

Creates a new typed Props that uses the given creator function to create instances of this actor.
Creates a new typed Props that uses the given creator function to create instances of this actor.
CAVEAT: Required mailbox type cannot be detected when using anonymous mixin composition when creating the instance. For example, the following will not detect the need for DequeBasedMessageQueueSemantics as defined in Stash:
```
Props(new Actor with Stash { ... })
```
Instead you must create a named class that mixin the trait, e.g.
```
class MyActor extends Actor with Stash
```
Wrapper for akka.actor.Props[T](=> T).
A
the message type this actor is receiving
T
the actor type
creator
the thunk that create the new instance of this actor
returns
a typed Props to create ActorRef[A]s for this actor
def Props[A, T <: Actor](implicit arg0: ClassTag[T]): Props[A]

Creates a new typed Props that uses the default constructor of the given actor type to create new instances of this actor.
Creates a new typed Props that uses the default constructor of the given actor type to create new instances of this actor.
Wrapper for akka.actor.Props[T]
A
the message type this actor is receiving
T
the actor type
returns
a typed Props to create ActorRef[A]s for this actor
def PropsFor[T <: TypedActor](clazz: Class[T], args: Any*): Props[typed.PropsFor.T.Message]

Creates a new typed Props that uses the given class and constructor arguments to create instances of this typed actor.
Creates a new typed Props that uses the given class and constructor arguments to create instances of this typed actor.
The message type is derived from the given actor.
T
the typed actor
clazz
the class of this typed actor
args
the constructor argumentes of this actor
returns
a typed Props to create ActorRef[A]s for this actor
def PropsFor[T <: TypedActor](creator: ⇒ T)(implicit arg0: ClassTag[T]): Props[typed.PropsFor.T.Message]

Creates a new typed Props that uses the given creator function to create instances of this typed actor.
Creates a new typed Props that uses the given creator function to create instances of this typed actor.
The message type is derived from the given actor.
T
the typed actor
creator
the thunk that create the new instance of this typed actor
returns
a typed Props to create ActorRef[A]s for this actor

See also
Props for some caveat about this constructor.
def PropsFor[T <: TypedActor](implicit arg0: ClassTag[T]): Props[typed.PropsFor.T.Message]

Creates a new typed Props that uses the default constructor of the given actor to create new instances of this typed actor.
Creates a new typed Props that uses the default constructor of the given actor to create new instances of this typed actor.
The message type is derived from the given actor.
T
the typed actor
returns
a typed Props to create ActorRef[A]s for this actor
def PropsOf[A]: PropsBuilder[A]

Type-curried creation of Props[A] to aid type inference.
Type-curried creation of Props[A] to aid type inference.
A
the message type this actor is receiving
returns
a class that created typed Props using one of the above methods
Example:
1. // message gets inferred as Nothing Props(new MyActor): Props[Nothing] // too verbose Props[MyMessage, MyActor](new MyActor): Props[MyMessage] // guided inference PropsOf[MyMessage](new MyActor): Props[MyMessage]

object Typed

A shapeless-powered, typed variant of the actor/props creation.

A shapeless-powered, typed variant of the actor/props creation. This is an alternative over constructors, that use the Class[A], Any* overload to create actors.

You must use TypedActors and these actors must be case classes for this to work.

Example:

case class ExampleActor(foo: Option[String]) extends TypedActor.Of[String] {
  def typedReceive: TypedReceive = ???
}

// runtime error (IllegalArgumentException: no matching constructor found):
val runtimeError: ActorRef[String] =
  ActorOf(PropsOf[String](classOf[ExampleActor1], "wrong type"))

// compiletime error:
//   found   : String("wrong type") :: HNil
//   required: Option[String] :: HNil
val compiletimeError: ActorRef[String] =
  Typed[ExampleActor2].create("wrong type")

Usage

Use apply with the TypedActor as the type parameter and then call either create or props with the appropriate constructor parameters to create either an ActorRef or a Props.

object TypedActor
val UntypedProps: Props.type
object containsAllOf
object containsSomeOf extends ContainsSomeOf0
object isNotA
object isPartOf extends IsPartOf0

package typed

Type Members

type ActorRef[A] = AnyRef { ... /* 2 definitions in type refinement */ }

implicit final class ActorRefOps[A] extends AnyVal

implicit final class ActorRefUnionedOps[U <: Union] extends AnyVal

sealed trait ContainsSomeOf0 extends AnyRef

sealed trait IsPartOf0 extends AnyRef

sealed trait IsUnion[-A] extends AnyRef

type Props[A] = AnyRef { ... /* 2 definitions in type refinement */ }

final class PropsBuilder[A] extends AnyVal

implicit final class PropsOps[A] extends AnyVal

trait TypedActor extends Actor

sealed trait Union extends AnyRef

type UntypedActorRef = akka.actor.ActorRef

implicit final class UntypedActorRefOps extends AnyVal

type UntypedProps = akka.actor.Props

implicit final class UntypedPropsOps extends AnyVal

sealed trait containsAllOf[U <: Union, T <: Union] extends AnyRef

sealed trait containsSomeOf[U <: Union, T <: Union] extends AnyRef

sealed trait isNotA[A, B] extends AnyRef

sealed trait isPartOf[A, +U <: Union] extends AnyRef

sealed trait |[+A, +B] extends Union

Value Members

def ActorOf[A](p: Props[A])(implicit factory: ActorRefFactory): ActorRef[A]

def ActorOf[A](p: Props[A], name: String)(implicit factory: ActorRefFactory): ActorRef[A]

object IsUnion

def Props[A](p: UntypedProps): Props[A]

def Props[A, T <: Actor](clazz: Class[T], args: Any*): Props[A]

def Props[A, T <: Actor](creator: ⇒ T)(implicit arg0: ClassTag[T]): Props[A]

def Props[A, T <: Actor](implicit arg0: ClassTag[T]): Props[A]

def PropsFor[T <: TypedActor](clazz: Class[T], args: Any*): Props[typed.PropsFor.T.Message]

def PropsFor[T <: TypedActor](creator: ⇒ T)(implicit arg0: ClassTag[T]): Props[typed.PropsFor.T.Message]

def PropsFor[T <: TypedActor](implicit arg0: ClassTag[T]): Props[typed.PropsFor.T.Message]

def PropsOf[A]: PropsBuilder[A]

object Typed

Usage

object TypedActor

val UntypedProps: Props.type

object containsAllOf

object containsSomeOf extends ContainsSomeOf0

object isNotA

object isPartOf extends IsPartOf0

Inherited from AnyRef

Inherited from Any

Ungrouped