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: 1.1.3.30 (1.1.3.30)
Syntax
public abstract class ActorPath : IEquatable<ActorPath>, 
	IComparable<ActorPath>, ISurrogated

The ActorPath type exposes the following members.

Constructors
  NameDescription
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.
Top
Properties
  NameDescription
Public propertyAddress
The Address under which this path can be reached; walks up the tree to the RootActorPath.
Public propertyElements
Gets the elements.
Public propertyElementsWithUid
INTERNAL API. Used in Akka.Remote - when resolving deserialized local actor references we need to be able to include the UID at the tail end of the elements. It's implemented in this class because we don't have an ActorPathExtractor equivalent.
Public propertyName
Gets the name.
Public propertyParent
TBD
Public propertyRoot
TBD
Public propertyUid
Gets the uid.
Top
Methods
  NameDescription
Public methodChild
Creates a child with the specified name
Public methodCompareTo
TBD
Public methodEquals(Object)
Determines whether the specified Object is equal to this instance.
(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
TBD
Public methodGetHashCode
Returns a hash code for this instance.
(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, http://www.ietf.org/rfc/rfc2396.txt 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
TBD
Public methodToSerializationFormat
TBD
Public methodToSerializationFormatWithAddress
TBD
Public methodToString
Returns a String that represents this instance.
(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
TBD
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
TBD
Public methodWithUid
Withes the uid.
Top
Operators
Extension Methods
See Also