ActorContext
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 pekko.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.
Attributes
- Source
- ActorCell.scala
- Graph
-
- Supertypes
- Known subtypes
-
trait ActorContext
Members list
Value members
Abstract methods
Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler. This method acts upon the behavior stack as follows:
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 = trueit will replace the top element (i.e. the current behavior) - if
discardOld = falseit 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())
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Get the child with the given name if it exists.
Get the child with the given name if it exists.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
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:
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")
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Returns the supervising parent ActorRef.
Returns the supervising parent ActorRef.
This method is thread-safe and can be called from other threads than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Retrieve the Props which were used to create this actor.
Retrieve the Props which were used to create this actor.
This method is thread-safe and can be called from other threads than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Gets the current receive timeout. When specified, the receive method should be able to handle a pekko.actor.ReceiveTimeout message.
Gets the current receive timeout. When specified, the receive method should be able to handle a pekko.actor.ReceiveTimeout message.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
The ActorRef representing this actor
The ActorRef representing this actor
This method is thread-safe and can be called from other threads than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Returns the sender 'ActorRef' of the current message.
Returns the sender 'ActorRef' of the current message.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Defines the inactivity timeout after which the sending of a pekko.actor.ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a pekko.actor.ReceiveTimeout message. 1 millisecond is the minimum supported timeout.
Defines the inactivity timeout after which the sending of a pekko.actor.ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a pekko.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.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Reverts the Actor behavior to the previous one on the behavior stack.
Reverts the Actor behavior to the previous one on the behavior stack.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
Unregisters this actor as Monitor for the provided ActorRef.
Unregisters this actor as Monitor for the provided ActorRef.
Attributes
- Returns
-
the provided ActorRef Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
- Source
- ActorCell.scala
Registers this actor as a Monitor for the provided ActorRef. This actor will receive a Terminated(subject) message when watched actor is terminated.
Registers this actor as a Monitor for the provided ActorRef. This actor will receive a Terminated(subject) message when watched actor is terminated.
watch is idempotent if it is not mixed with watchWith.
It will fail with a java.lang.IllegalStateException if the same subject was watched before using watchWith. To clear the termination message, unwatch first.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Returns
-
the provided ActorRef
- Source
- ActorCell.scala
Registers this actor as a Monitor for the provided ActorRef. This actor will receive the specified message when watched actor is terminated.
Registers this actor as a Monitor for the provided ActorRef. This actor will receive the specified message when watched actor is terminated.
watchWith is idempotent if it is called with the same msg and not mixed with watch.
It will fail with a java.lang.IllegalStateException if the same subject was watched before using watch or watchWith with another termination message. To change the termination message, unwatch first.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Returns
-
the provided ActorRef
- Source
- ActorCell.scala
Concrete methods
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.
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.
Warning: This method is not thread-safe and must not be accessed from threads other than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
ActorContexts shouldn't be Serializable
Inherited methods
Construct a pekko.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.
Construct a pekko.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.
Attributes
- Inherited from:
- ActorRefFactory
- Source
- ActorRefProvider.scala
Construct a pekko.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.
Construct a pekko.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.
Attributes
- Inherited from:
- ActorRefFactory
- Source
- ActorRefProvider.scala
Inherited and Abstract methods
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.
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 pekko.actor.Props for details on how to obtain a Props object.
Attributes
- Throws
-
java.lang.UnsupportedOperationException
if invoked on an ActorSystem that uses a custom user guardian
pekko.ConfigurationExceptionif deployment, dispatcher or mailbox configuration is wrong
pekko.actor.InvalidActorNameExceptionif the given name is invalid or already in use
- Inherited from:
- ActorRefFactory
- Source
- ActorRefProvider.scala
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 pekko.actor.Props for details on how to obtain a Props object.
Attributes
- Throws
-
java.lang.UnsupportedOperationException
if invoked on an ActorSystem that uses a custom user guardian
pekko.ConfigurationExceptionif deployment, dispatcher or mailbox configuration is wrong
- Inherited from:
- ActorRefFactory
- Source
- ActorRefProvider.scala
Parent of all children created by this interface.
Parent of all children created by this interface.
INTERNAL API
Attributes
- Inherited from:
- ActorRefFactory
- Source
- ActorRefProvider.scala
INTERNAL API
INTERNAL API
Stop the actor pointed to by the given pekko.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.
Stop the actor pointed to by the given pekko.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.
Attributes
- Inherited from:
- ActorRefFactory
- Source
- ActorRefProvider.scala
INTERNAL API
Implicits
Implicits
Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place an implicit ExecutionContext in scope.
Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place an implicit ExecutionContext in scope.
This method is thread-safe and can be called from other threads than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala
The system that the actor belongs to. Importing this member will place an implicit ActorSystem in scope.
The system that the actor belongs to. Importing this member will place an implicit ActorSystem in scope.
This method is thread-safe and can be called from other threads than the ordinary actor message processing thread, such as java.util.concurrent.CompletionStage and scala.concurrent.Future callbacks.
Attributes
- Source
- ActorCell.scala