Packages

t

akka.actor

AbstractActorContext

trait AbstractActorContext extends ActorContext

AbstractActorContext is the AbstractActor equivalent of ActorContext, containing the Java API

Source
ActorCell.scala
Linear Supertypes
ActorContext, ActorRefFactory, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractActorContext
  2. ActorContext
  3. ActorRefFactory
  4. AnyRef
  5. 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

    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

    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

    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())

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

    Get the child with the given name if it exists.

    Get the child with the given name if it exists.

    Definition Classes
    ActorContext
  5. abstract def children: Iterable[ActorRef]

    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")
    Definition Classes
    ActorContext
  6. implicit abstract def dispatcher: ExecutionContextExecutor

    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
    ActorContext → ActorRefFactory
  7. abstract def getChild(name: String): ActorRef

    Returns a reference to the named child or null if no child with that name exists.

  8. abstract def getChildren(): Iterable[ActorRef]

    Returns an unmodifiable Java Collection containing the linked actors, please note that the backing map is thread-safe but not immutable

  9. abstract def parent: ActorRef

    Returns the supervising parent ActorRef.

    Returns the supervising parent ActorRef.

    Definition Classes
    ActorContext
  10. abstract def props: Props

    Retrieve the Props which were used to create this actor.

    Retrieve the Props which were used to create this actor.

    Definition Classes
    ActorContext
  11. abstract def receiveTimeout: Duration

    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.

    Definition Classes
    ActorContext
  12. abstract def self: ActorRef
    Definition Classes
    ActorContext
  13. abstract def sender(): ActorRef

    Returns the sender 'ActorRef' of the current message.

    Returns the sender 'ActorRef' of the current message.

    Definition Classes
    ActorContext
  14. abstract def setReceiveTimeout(timeout: Duration): Unit

    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.

    Definition Classes
    ActorContext
  15. abstract def stop(actor: ActorRef): Unit

    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
  16. implicit abstract def system: ActorSystem

    The system that the actor belongs to.

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

    Definition Classes
    ActorContext
  17. abstract def unbecome(): Unit

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

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

    Definition Classes
    ActorContext
  18. abstract def unwatch(subject: ActorRef): ActorRef

    Unregisters this actor as Monitor for the provided ActorRef.

    Unregisters this actor as Monitor for the provided ActorRef.

    returns

    the provided ActorRef

    Definition Classes
    ActorContext
  19. abstract def watch(subject: ActorRef): ActorRef

    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

    Definition Classes
    ActorContext

Concrete Value Members

  1. def actorSelection(path: ActorPath): ActorSelection

    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
  2. def actorSelection(path: String): ActorSelection

    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
  3. def become(behavior: Receive): Unit

    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.

    Definition Classes
    ActorContext