ActorPath

org.apache.pekko.actor.ActorPath
See theActorPath companion object
sealed trait ActorPath extends Comparable[ActorPath], Serializable

Actor path is a unique path to an actor that shows the creation path up through the actor tree to the root actor.

ActorPath defines a natural ordering (so that ActorRefs can be put into collections with this requirement); this ordering is intended to be as fast as possible, which owing to the bottom-up recursive nature of ActorPath is sorted by path elements FROM RIGHT TO LEFT, where RootActorPath > ChildActorPath in case the number of elements is different.

Two actor paths are compared equal when they have the same name and parent elements, including the root address information. That does not necessarily mean that they point to the same incarnation of the actor if the actor is re-created with the same path. In other words, in contrast to how actor references are compared the unique id of the actor is not taken into account when comparing actor paths.

Attributes

Companion
object
Source
ActorPath.scala
Graph
Supertypes
trait Serializable
trait Comparable[ActorPath]
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def /(child: String): ActorPath

Create a new child actor path.

Create a new child actor path.

Attributes

Source
ActorPath.scala

The Address under which this path can be reached; walks up the tree to the RootActorPath.

The Address under which this path can be reached; walks up the tree to the RootActorPath.

Attributes

Source
ActorPath.scala

Sequence of names for this path from root to this. Performance implication: has to allocate a list.

Sequence of names for this path from root to this. Performance implication: has to allocate a list.

Attributes

Source
ActorPath.scala
def name: String

The name of the actor that this path refers to.

The name of the actor that this path refers to.

Attributes

Source
ActorPath.scala

The path for the parent actor.

The path for the parent actor.

Attributes

Source
ActorPath.scala

Walk up the tree to obtain and return the RootActorPath.

Walk up the tree to obtain and return the RootActorPath.

Attributes

Source
ActorPath.scala

Generate full String representation including the uid for the actor cell instance as URI fragment. This representation should be used as serialized representation instead of toString.

Generate full String representation including the uid for the actor cell instance as URI fragment. This representation should be used as serialized representation instead of toString.

Attributes

Source
ActorPath.scala

Generate full String representation including the uid for the actor cell instance as URI fragment, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information. This representation should be used as serialized representation instead of toStringWithAddress.

Generate full String representation including the uid for the actor cell instance as URI fragment, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information. This representation should be used as serialized representation instead of toStringWithAddress.

Attributes

Source
ActorPath.scala

Generate String representation, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information.

Generate String representation, replacing the Address in the RootActor Path with the given one unless this path’s address includes host and port information.

Attributes

Source
ActorPath.scala

Concrete methods

def /(child: Iterable[String]): ActorPath

Recursively create a descendant’s path by appending all child names.

Recursively create a descendant’s path by appending all child names.

Attributes

Source
ActorPath.scala
def child(child: String): ActorPath

Java API: Create a new child actor path.

Java API: Create a new child actor path.

Attributes

Source
ActorPath.scala
def descendant(names: Iterable[String]): ActorPath

Java API: Recursively create a descendant’s path by appending all child names.

Java API: Recursively create a descendant’s path by appending all child names.

Attributes

Source
ActorPath.scala
def getElements: Iterable[String]

Java API: Sequence of names for this path from root to this. Performance implication: has to allocate a list.

Java API: Sequence of names for this path from root to this. Performance implication: has to allocate a list.

Attributes

Source
ActorPath.scala

String representation of the path elements, excluding the address information. The elements are separated with "/" and starts with "/", e.g. "/user/a/b".

String representation of the path elements, excluding the address information. The elements are separated with "/" and starts with "/", e.g. "/user/a/b".

Attributes

Source
ActorPath.scala

Inherited and Abstract methods

def compareTo(x$0: ActorPath): Int

Attributes

Inherited from:
Comparable