SocketAddress<A extends Host> final

final class SocketAddress<A extends Host>

A network socket address — a Host paired with a Port.

The type parameter A constrains the host to a specific subtype of Host, allowing e.g. SocketAddress<Ipv4Address> for IPv4-only addresses.

IPv6 addresses are formatted with brackets: [::1]:8080. Other hosts use the plain host:port form.

Constructors

SocketAddress() const

const SocketAddress(A host, Port port)

Implementation

const SocketAddress(this.host, this.port);

Properties

hashCode no setter override

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Implementation

@override
int get hashCode => Object.hashAll([host, port]);

host final

final A host

The host component of this socket address.

Implementation

final A host;

port final

final Port port

The port component of this socket address.

Implementation

final Port port;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() override

String toString()

Returns [host]:port for IPv6 hosts, or host:port for all others.

Implementation

@override
String toString() => switch (host) {
  final Ipv6Address _ => '[$host]:$port',
  _ => '$host:$port',
};

Operators

operator ==() override

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Implementation

@override
bool operator ==(Object other) => switch (other) {
  final SocketAddress that => host == that.host && port == that.port,
  _ => false,
};

Static Properties

Wildcard final

final SocketAddress<Ipv4Address> Wildcard

The wildcard socket address 0.0.0.0:0.

Implementation

static final Wildcard = SocketAddress(Ipv4Address.Wildcard, Port.Wildcard);

Static Methods

fromString()

Option<SocketAddress<Host>> fromString(String value)

Parses value as a socket address with any supported host type (IP address, hostname, or IDN), returning None if parsing fails.

Implementation

static Option<SocketAddress<Host>> fromString(String value) => fromStringIp(value)
    .map((a) => a as SocketAddress<Host>) &#47;&#47; ignore: unnecessary_cast
    .orElse(
      () => fromStringHostname(
        value,
      ).map((a) => a as SocketAddress<Host>), &#47;&#47; ignore: unnecessary_cast
    )
    .orElse(
      () => fromStringIDN(value).map((a) => a as SocketAddress<Host>), &#47;&#47; ignore: unnecessary_cast
    );

fromStringHostname()

Option<SocketAddress<Hostname>> fromStringHostname(String value)

Parses value as a socket address with an ASCII Hostname host, returning None if parsing fails.

Implementation

static Option<SocketAddress<Hostname>> fromStringHostname(String value) =>
    _stringMatch(value, _unescapedPattern).flatMapN(
      (hostStr, portStr) =>
          (Hostname.fromString(hostStr), Port.fromString(portStr)).mapN(SocketAddress.new),
    );

fromStringIDN()

Option<SocketAddress<IDN>> fromStringIDN(String value)

Parses value as a socket address with an IDN host, returning None if parsing fails.

Implementation

static Option<SocketAddress<IDN>> fromStringIDN(String value) =>
    _stringMatch(value, _unescapedPattern).flatMapN(
      (hostStr, portStr) =>
          (IDN.fromString(hostStr), Port.fromString(portStr)).mapN(SocketAddress.new),
    );

fromStringIp()

Option<SocketAddress<IpAddress>> fromStringIp(String value)

Parses value as a socket address with an IpAddress host (IPv4 or IPv6), returning None if parsing fails.

Implementation

static Option<SocketAddress<IpAddress>> fromStringIp(String value) => fromStringIp4(value)
    .map((a) => a as SocketAddress<IpAddress>) &#47;&#47; ignore: unnecessary_cast
    .orElse(() => fromStringIp6(value));

fromStringIp4()

Option<SocketAddress<Ipv4Address>> fromStringIp4(String value)

Parses value as an IPv4 socket address in a.b.c.d:port form, returning None if parsing fails.

Implementation

static Option<SocketAddress<Ipv4Address>> fromStringIp4(String value) =>
    _stringMatch(value, _unescapedPattern).flatMapN(
      (hostStr, portStr) =>
          (Ipv4Address.fromString(hostStr), Port.fromString(portStr)).mapN(SocketAddress.new),
    );

fromStringIp6()

Option<SocketAddress<Ipv6Address>> fromStringIp6(String value)

Parses value as an IPv6 socket address in [addr]:port form, returning None if parsing fails.

Implementation

static Option<SocketAddress<Ipv6Address>> fromStringIp6(String value) =>
    _stringMatch(value, _v6Pattern).flatMapN(
      (hostStr, portStr) =>
          (Ipv6Address.fromString(hostStr), Port.fromString(portStr)).mapN(SocketAddress.new),
    );

withPort()

SocketAddress<Host> withPort(Port port)

Returns a wildcard host socket address bound to port.

Implementation

static SocketAddress withPort(Port port) => SocketAddress(Ipv4Address.Wildcard, port);