RawSocketOption final

final class RawSocketOption

The RawSocketOption is used as a parameter to Socket.setRawOption and RawSocket.setRawOption to customize the behaviour of the underlying socket.

It allows for fine grained control of the socket options, and its values will be passed to the underlying platform's implementation of setsockopt and getsockopt.

Constructors

RawSocketOption() const

const RawSocketOption(int level, int option, Uint8List value)

Creates a RawSocketOption for RawSocket.getRawOption and RawSocket.setRawOption.

The level and option arguments correspond to level and optname arguments on the getsockopt() and setsockopt() native calls.

The value argument and its length correspond to the optval and length arguments on the native call.

For a RawSocket.getRawOption call, the value parameter will be updated after a successful call (although its length will not be changed).

For a RawSocket.setRawOption call, the value parameter will be used set the option.

Implementation

const RawSocketOption(this.level, this.option, this.value);

RawSocketOption.fromBool() factory

factory RawSocketOption.fromBool(int level, int option, bool value)

Convenience constructor for creating a boolean based RawSocketOption.

Implementation

factory RawSocketOption.fromBool(int level, int option, bool value) =>
    RawSocketOption.fromInt(level, option, value ? 1 : 0);

RawSocketOption.fromInt() factory

factory RawSocketOption.fromInt(int level, int option, int value)

Convenience constructor for creating an integer based RawSocketOption.

Implementation

factory RawSocketOption.fromInt(int level, int option, int value) {
  final Uint8List list = Uint8List(4);
  final buffer = ByteData.view(list.buffer, list.offsetInBytes);
  buffer.setInt32(0, value, Endian.host);
  return RawSocketOption(level, option, list);
}

Properties

hashCode no setter inherited

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.

Inherited from Object.

Implementation

external int get hashCode;

level final

final int level

The level for the option to set or get.

See also:

• RawSocketOption.levelSocket
• RawSocketOption.levelIPv4
• RawSocketOption.levelIPv6
• RawSocketOption.levelTcp
• RawSocketOption.levelUdp

Implementation

final int level;

option final

final int option

The numeric ID of the option to set or get.

Implementation

final int option;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

value final

final Uint8List value

The raw data to set, or the array to write the current option value into.

This list must be the correct length for the expected option. For most options that take int or bool values, the length should be 4. For options that expect a struct (such as an in_addr_t), the length should be the correct length for that struct.

Implementation

final Uint8List value;

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() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

external String toString();

Operators

operator ==() inherited

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.

Inherited from Object.

Implementation

external bool operator ==(Object other);

Static Properties

IPv4MulticastInterface no setter

int get IPv4MulticastInterface

Socket option for IP_MULTICAST_IF.

Implementation

static int get IPv4MulticastInterface =>
    _getOptionValue(_RawSocketOptions.IP_MULTICAST_IF.index);

IPv6MulticastInterface no setter

int get IPv6MulticastInterface

Socket option for IPV6_MULTICAST_IF.

Implementation

static int get IPv6MulticastInterface =>
    _getOptionValue(_RawSocketOptions.IPV6_MULTICAST_IF.index);

levelIPv4 no setter

int get levelIPv4

Socket level option for IPPROTO_IP.

Implementation

static int get levelIPv4 =>
    _getOptionValue(_RawSocketOptions.IPPROTO_IP.index);

levelIPv6 no setter

int get levelIPv6

Socket level option for IPPROTO_IPV6.

Implementation

static int get levelIPv6 =>
    _getOptionValue(_RawSocketOptions.IPPROTO_IPV6.index);

levelSocket no setter

int get levelSocket

Socket level option for SOL_SOCKET.

Implementation

static int get levelSocket =>
    _getOptionValue(_RawSocketOptions.SOL_SOCKET.index);

levelTcp no setter

int get levelTcp

Socket level option for IPPROTO_TCP.

Implementation

static int get levelTcp =>
    _getOptionValue(_RawSocketOptions.IPPROTO_TCP.index);

levelUdp no setter

int get levelUdp

Socket level option for IPPROTO_UDP.

Implementation

static int get levelUdp =>
    _getOptionValue(_RawSocketOptions.IPPROTO_UDP.index);