Trait

akka.actor

ActorContext

Related Doc: package actor

Permalink

trait ActorContext extends ActorRefFactory

The actor context - the view of the actor cell from the actor. Exposes contextual information for the actor and the current message.

There are several possibilities for creating actors (see akka.actor.Props for details on props):

// Java or Scala
context.actorOf(props, "name")
context.actorOf(props)

// Scala
context.actorOf(Props[MyActor])
context.actorOf(Props(classOf[MyActor], arg1, arg2), "name")

// Java
getContext().actorOf(Props.create(MyActor.class));
getContext().actorOf(Props.create(MyActor.class, arg1, arg2), "name");

Where no name is given explicitly, one will be automatically generated.

Source
ActorCell.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorContext
  2. ActorRefFactory
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def actorOf(props: Props, name: String): ActorRef

    Permalink

    Create new actor as child of this context with the given name, which must not be null, empty or start with “$”.

    Create new actor as child of this context with the given name, which must not be null, empty or start with “$”. If the given name is already in use, an InvalidActorNameException is thrown.

    See akka.actor.Props for details on how to obtain a Props object.

    Definition Classes
    ActorRefFactory
    Exceptions thrown

    UnsupportedOperationException if invoked on an ActorSystem that uses a custom user guardian

    akka.ConfigurationException if deployment, dispatcher or mailbox configuration is wrong

    akka.actor.InvalidActorNameException if the given name is invalid or already in use

  2. abstract def actorOf(props: Props): ActorRef

    Permalink

    Create new actor as child of this context and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with “$” prepended, may change in the future).

    Create new actor as child of this context and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with “$” prepended, may change in the future).

    See akka.actor.Props for details on how to obtain a Props object.

    Definition Classes
    ActorRefFactory
    Exceptions thrown

    UnsupportedOperationException if invoked on an ActorSystem that uses a custom user guardian

    akka.ConfigurationException if deployment, dispatcher or mailbox configuration is wrong

  3. abstract def become(behavior: Receive, discardOld: Boolean): Unit

    Permalink

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler.

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler. This method acts upon the behavior stack as follows:

    • if discardOld = true it will replace the top element (i.e. the current behavior)
    • if discardOld = false it will keep the current behavior and push the given one atop

    The default of replacing the current behavior on the stack has been chosen to avoid memory leaks in case client code is written without consulting this documentation first (i.e. always pushing new behaviors and never issuing an unbecome())

  4. abstract def child(name: String): Option[ActorRef]

    Permalink

    Get the child with the given name if it exists.

  5. abstract def children: Iterable[ActorRef]

    Permalink

    Returns all supervised children; this method returns a view (i.e.

    Returns all supervised children; this method returns a view (i.e. a lazy collection) onto the internal collection of children. Targeted lookups should be using child instead for performance reasons:

    val badLookup = context.children find (_.path.name == "kid")
    // should better be expressed as:
    val goodLookup = context.child("kid")
  6. implicit abstract def dispatcher: ExecutionContextExecutor

    Permalink

    Returns the dispatcher (MessageDispatcher) that is used for this Actor.

    Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place an implicit ExecutionContext in scope.

    Definition Classes
    ActorContextActorRefFactory
  7. abstract def guardian: InternalActorRef

    Permalink

    Father of all children created by this interface.

    Father of all children created by this interface.

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  8. abstract def lookupRoot: InternalActorRef

    Permalink

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  9. abstract def parent: ActorRef

    Permalink

    Returns the supervising parent ActorRef.

  10. abstract def props: Props

    Permalink

    Retrieve the Props which were used to create this actor.

  11. abstract def provider: ActorRefProvider

    Permalink

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  12. abstract def receiveTimeout: Duration

    Permalink

    Gets the current receive timeout.

    Gets the current receive timeout. When specified, the receive method should be able to handle a akka.actor.ReceiveTimeout message.

  13. abstract def self: ActorRef

    Permalink
  14. abstract def sender(): ActorRef

    Permalink

    Returns the sender 'ActorRef' of the current message.

  15. abstract def setReceiveTimeout(timeout: Duration): Unit

    Permalink

    Defines the inactivity timeout after which the sending of a akka.actor.ReceiveTimeout message is triggered.

    Defines the inactivity timeout after which the sending of a akka.actor.ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a akka.actor.ReceiveTimeout message. 1 millisecond is the minimum supported timeout.

    Please note that the receive timeout might fire and enqueue the ReceiveTimeout message right after another message was enqueued; hence it is not guaranteed that upon reception of the receive timeout there must have been an idle period beforehand as configured via this method.

    Once set, the receive timeout stays in effect (i.e. continues firing repeatedly after inactivity periods). Pass in Duration.Undefined to switch off this feature.

    Messages marked with NotInfluenceReceiveTimeout will not reset the timer. This can be useful when ReceiveTimeout should be fired by external inactivity but not influenced by internal activity, e.g. scheduled tick messages.

  16. abstract def stop(actor: ActorRef): Unit

    Permalink

    Stop the actor pointed to by the given akka.actor.ActorRef; this is an asynchronous operation, i.e.

    Stop the actor pointed to by the given akka.actor.ActorRef; this is an asynchronous operation, i.e. involves a message send. If this method is applied to the self reference from inside an Actor then that Actor is guaranteed to not process any further messages after this call; please note that the processing of the current message will continue, this method does not immediately terminate this actor.

    Definition Classes
    ActorRefFactory
  17. implicit abstract def system: ActorSystem

    Permalink

    The system that the actor belongs to.

    The system that the actor belongs to. Importing this member will place an implicit ActorSystem in scope.

  18. abstract def systemImpl: ActorSystemImpl

    Permalink

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  19. abstract def unbecome(): Unit

    Permalink

    Reverts the Actor behavior to the previous one on the behavior stack.

  20. abstract def unwatch(subject: ActorRef): ActorRef

    Permalink

    Unregisters this actor as Monitor for the provided ActorRef.

    Unregisters this actor as Monitor for the provided ActorRef.

    returns

    the provided ActorRef

  21. abstract def watch(subject: ActorRef): ActorRef

    Permalink

    Registers this actor as a Monitor for the provided ActorRef.

    Registers this actor as a Monitor for the provided ActorRef. This actor will receive a Terminated(subject) message when watched actor is terminated.

    returns

    the provided ActorRef

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to any2stringadd[ActorContext] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorContext, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to ArrowAssoc[ActorContext] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def actorSelection(path: ActorPath): ActorSelection

    Permalink

    Construct an akka.actor.ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).

    Construct an akka.actor.ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.

    Definition Classes
    ActorRefFactory
  7. def actorSelection(path: String): ActorSelection

    Permalink

    Construct an akka.actor.ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).

    Construct an akka.actor.ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.

    Definition Classes
    ActorRefFactory
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def become(behavior: Receive): Unit

    Permalink

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler.

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler. Replaces the current behavior on the top of the behavior stack.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (ActorContext) ⇒ Boolean, msg: ⇒ Any): ActorContext

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to Ensuring[ActorContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ActorContext) ⇒ Boolean): ActorContext

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to Ensuring[ActorContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): ActorContext

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to Ensuring[ActorContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ActorContext

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to Ensuring[ActorContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to StringFormat[ActorContext] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def writeObject(o: ObjectOutputStream): Unit

    Permalink

    ActorContexts shouldn't be Serializable

    ActorContexts shouldn't be Serializable

    Attributes
    protected
  31. def [B](y: B): (ActorContext, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ActorContext to ArrowAssoc[ActorContext] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ActorRefFactory

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorContext to any2stringadd[ActorContext]

Inherited by implicit conversion StringFormat from ActorContext to StringFormat[ActorContext]

Inherited by implicit conversion Ensuring from ActorContext to Ensuring[ActorContext]

Inherited by implicit conversion ArrowAssoc from ActorContext to ArrowAssoc[ActorContext]

Ungrouped