Click or drag to resize
Akka.NETActorPath Class
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.
Inheritance Hierarchy

Namespace:  Akka.Actor
Assembly:  Akka (in Akka.dll) Version: (
public abstract class ActorPath : IEquatable<ActorPath>, 
	IComparable<ActorPath>, ISurrogated

The ActorPath type exposes the following members.

Protected methodActorPath(Address, String)
Initializes a new instance of the ActorPath class.
Protected methodActorPath(ActorPath, String, Int64)
Initializes a new instance of the ActorPath class.
Public propertyAddress
The Address under which this path can be reached; walks up the tree to the RootActorPath.
Public propertyElements
Gets the elements.
Public propertyName
Gets the name.
Public propertyParent
Public propertyRoot
Public propertyUid
Gets the uid.
Public methodChild
Creates a child with the specified name
Public methodCompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(ActorPath)
Indicates whether the current object is equal to another object of the same type.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberFormatPathElements
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIsValidPathElement
Method that checks if actor name conforms to RFC 2396, Note that AKKA JVM does not allow parenthesis ( ) but, according to RFC 2396 those are allowed, and since we use URL Encode to create valid actor names, we must allow them.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberParse
Creates an ActorPath from the specified path.
Public methodToSerializationFormat
Public methodToSerializationFormatWithAddress
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Public methodToStringWithAddress
Generate String representation, with the address in the RootActorPath.
Public methodToStringWithAddress(Address)
Generate String representation, replacing the Address in the RootActorPath with the given one unless this path’s address includes host and port information.
Public methodToStringWithoutAddress
String representation of the path elements, excluding the address information. The elements are separated with "/" and starts with "/", e.g. "/user/a/b".
Public methodToStringWithUid
Returns a string representation of this instance including uid.
Public methodToSurrogate
Creates a surrogate representation of the current ActorPath.
Public methodStatic memberTryParse
Tries to parse the uri, which should be a full uri, i.e containing protocol. For example "akka://System/user/my-actor"
Public methodStatic memberTryParseAddress
Public methodWithUid
Withes the uid.
Public operatorStatic memberDivision(ActorPath, IEnumerableString)
Creates a new ActorPath by appending all the names in name to the specified path.
Public operatorStatic memberDivision(ActorPath, String)
Creates a new ChildActorPath with the specified parent path and the specified name.
Public operatorStatic memberEquality
Compares two specified actor paths for equality.
Public operatorStatic memberInequality
Compares two specified actor paths for inequality.
Extension Methods
See Also