Class Address

The address specifies the physical location under which an Actor can be reached. Examples are local addresses, identified by the ActorSystem's name, and remote addresses, identified by protocol, host and port.

This class is sealed to allow use as a case class (copy method etc.); if for example a remote transport would want to associate additional information with an address, then this must be done externally.

Inheritance

Object

Address

Implements

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public sealed class Address : IEquatable<Address>, IComparable<Address>, IComparable, ISurrogated, ICloneable

Constructors

| Improve this Doc View Source

Address(String, String, String, Nullable<Int32>)

TBD

Declaration

public Address(string protocol, string system, string host = null, int? port = null)

Parameters

Type	Name	Description
String	protocol	TBD
String	system	TBD
String	host	TBD
Nullable<Int32>	port	TBD

Fields

| Improve this Doc View Source

AllSystems

Pseudo address for all systems

Declaration

public static readonly Address AllSystems

Field Value

Type	Description
Address

| Improve this Doc View Source

Comparer

An Address comparer. Compares two addresses by their protocol, name, host and port.

Declaration

public static readonly IComparer<Address> Comparer

Field Value

Type	Description
IComparer<Address>

Properties

| Improve this Doc View Source

HasGlobalScope

Returns true if this Address is usable globally. Unlike locally defined addresses HasLocalScope addresses of global scope are safe to sent to other hosts, as they globally and uniquely identify an addressable entity.

Declaration

public bool HasGlobalScope { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

HasLocalScope

Returns true if this Address is only defined locally. It is not safe to send locally scoped addresses to remote hosts. See also HasGlobalScope

Declaration

public bool HasLocalScope { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

Host

TBD

Declaration

public string Host { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

Port

TBD

Declaration

public int? Port { get; }

Property Value

Type	Description
Nullable<Int32>

| Improve this Doc View Source

Protocol

TBD

Declaration

public string Protocol { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

System

TBD

Declaration

public string System { get; }

Property Value

Type	Description
String

Methods

| Improve this Doc View Source

Clone()

Creates a new copy with the same properties as the current address.

Declaration

public object Clone()

Returns

Type	Description
Object	A new copy of the current address

| Improve this Doc View Source

CompareTo(Address)

Compares current address with provided one by their protocol, name, host and port.

Declaration

public int CompareTo(Address other)

Parameters

Type	Name	Description
Address	other	Other address to compare with.

Returns

Type	Description
Int32

| Improve this Doc View Source

Equals(Address)

Declaration

public bool Equals(Address other)

Parameters

Type	Name	Description
Address	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

| Improve this Doc View Source

HostPort()

TBD

Declaration

public string HostPort()

Returns

Type	Description
String	TBD

| Improve this Doc View Source

Parse(String)

Parses a new Address from a given string

Declaration

public static Address Parse(string address)

Parameters

Type	Name	Description
String	address	The address to parse

Returns

Type	Description
Address	A populated Address object with host and port included, if available

Exceptions

Type	Condition
UriFormatException	Thrown if the address is not able to be parsed

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

| Improve this Doc View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current Address.

Declaration

public ISurrogate ToSurrogate(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	The actor system that owns this router.

Returns

Type	Description
ISurrogate	The surrogate representation of the current Address.

| Improve this Doc View Source

TryParse(ReadOnlySpan<Char>, out Address)

Parses a new Address from a given path

Declaration

public static bool TryParse(ReadOnlySpan<char> span, out Address address)

Parameters

Type	Name	Description
System.ReadOnlySpan<Char>	span	The span of address to parse
Address	address	If `true`, the parsed Address. Otherwise `null`.

Returns

Type	Description
Boolean	`true` if the Address could be parsed, `false` otherwise.

| Improve this Doc View Source

TryParse(ReadOnlySpan<Char>, out Address, out ReadOnlySpan<Char>)

Parses a new Address from a given path

Declaration

public static bool TryParse(ReadOnlySpan<char> span, out Address address, out ReadOnlySpan<char> absolutUri)

Parameters

Type	Name	Description
System.ReadOnlySpan<Char>	span	The span of address to parse
Address	address	If `true`, the parsed Address. Otherwise `null`.
System.ReadOnlySpan<Char>	absolutUri	If `true`, the absolut uri of the path. Otherwise default.

Returns

Type	Description
Boolean	`true` if the Address could be parsed, `false` otherwise.

| Improve this Doc View Source

TryParse(String, out Address)

Parses a new Address from a given path

Declaration

public static bool TryParse(string path, out Address address)

Parameters

Type	Name	Description
String	path	The span of address to parse
Address	address	If `true`, the parsed Address. Otherwise `null`.

Returns

Type	Description
Boolean	`true` if the Address could be parsed, `false` otherwise.

| Improve this Doc View Source

TryParse(String, out Address, out String)

Parses a new Address from a given path

Declaration

public static bool TryParse(string path, out Address address, out string absolutUri)

Parameters

Type	Name	Description
String	path	The span of address to parse
Address	address	If `true`, the parsed Address. Otherwise `null`.
String	absolutUri	If `true`, the absolut uri of the path. Otherwise default.

Returns

Type	Description
Boolean	`true` if the Address could be parsed, `false` otherwise.

| Improve this Doc View Source

WithHost(String)

Creates a new Address with a given host.

Declaration

public Address WithHost(string host = null)

Parameters

Type	Name	Description
String	host	The host used to configure the new address.

Returns

Type	Description
Address	A new address with the provided `host`.

| Improve this Doc View Source

WithPort(Nullable<Int32>)

Creates a new Address with a given port.

Declaration

public Address WithPort(int? port = null)

Parameters

Type	Name	Description
Nullable<Int32>	port	The port used to configure the new address.

Returns

Type	Description
Address	A new address with the provided `port`.

| Improve this Doc View Source

WithProtocol(String)

Creates a new Address with a given protocol.

Declaration

public Address WithProtocol(string protocol)

Parameters

Type	Name	Description
String	protocol	The protocol used to configure the new address.

Returns

Type	Description
Address	A new address with the provided `protocol`.

| Improve this Doc View Source

WithSystem(String)

Creates a new Address with a given system.

Declaration

public Address WithSystem(string system)

Parameters

Type	Name	Description
String	system	The system used to configure the new address.

Returns

Type	Description
Address	A new address with the provided `system`.

Operators

| Improve this Doc View Source

Equality(Address, Address)

Compares two specified addresses for equality.

Declaration

public static bool operator ==(Address left, Address right)

Parameters

Type	Name	Description
Address	left	The first address used for comparison
Address	right	The second address used for comparison

Returns

Type	Description
Boolean	`true` if both addresses are equal; otherwise `false`

| Improve this Doc View Source

Inequality(Address, Address)

Compares two specified addresses for inequality.

Declaration

public static bool operator !=(Address left, Address right)

Parameters

Type	Name	Description
Address	left	The first address used for comparison
Address	right	The second address used for comparison

Returns

Type	Description
Boolean	`true` if both addresses are not equal; otherwise `false`

Explicit Interface Implementations

| Improve this Doc View Source

IComparable.CompareTo(Object)

Declaration

int IComparable.CompareTo(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Int32

Implements

IEquatable<T>

IComparable<T>

IComparable

ISurrogated

ICloneable

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)