std.socket.socket.set_option - multiple declarations

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  Linger value
) @trusted;

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  void[] value
) @trusted;

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  int value
) @trusted;

In a typical application, you might also want to consider using a non-blocking socket instead of setting a timeout on a blocking one.

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  Duration value
) @trusted;

Note

While the receive timeout setting is generally quite accurate on *nix systems even for smaller durations, there are two issues to be aware of on Windows: First, although undocumented, the effective timeout duration seems to be the one set on the socket plus half a second. setOption() tries to compensate for that, but still, timeouts under 500ms are not possible on Windows. Second, be aware that the actual amount of time spent until a blocking call returns randomly varies on the order of 10ms.

Parameters

Throws

SocketException if setting the options fails.

Example

import std.datetime;
auto pair = socketPair();
scope(exit) foreach (s; pair) s.close();

// Set a receive timeout, and then wait at one end of
// the socket pair, knowing that no data will arrive.
pair[0].setOption(SocketOptionLevel.SOCKET,
    SocketOption.RCVTIMEO, dur!"seconds"(1));

auto sw = StopWatch(AutoStart.yes);
ubyte[1] buffer;
pair[0].receive(buffer);
writefln("Waited %s ms until the socket timed out.",
    sw.peek.msecs);

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  Linger value
) @trusted;

In a typical application, you might also want to consider using a non-blocking socket instead of setting a timeout on a blocking one.

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  Duration value
) @trusted;

Note

While the receive timeout setting is generally quite accurate on *nix systems even for smaller durations, there are two issues to be aware of on Windows: First, although undocumented, the effective timeout duration seems to be the one set on the socket plus half a second. setOption() tries to compensate for that, but still, timeouts under 500ms are not possible on Windows. Second, be aware that the actual amount of time spent until a blocking call returns randomly varies on the order of 10ms.

Parameters

Throws

SocketException if setting the options fails.

Example

import std.datetime;
auto pair = socketPair();
scope(exit) foreach (s; pair) s.close();

// Set a receive timeout, and then wait at one end of
// the socket pair, knowing that no data will arrive.
pair[0].setOption(SocketOptionLevel.SOCKET,
    SocketOption.RCVTIMEO, dur!"seconds"(1));

auto sw = StopWatch(AutoStart.yes);
ubyte[1] buffer;
pair[0].receive(buffer);
writefln("Waited %s ms until the socket timed out.",
    sw.peek.msecs);

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  void[] value
) @trusted;

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  int value
) @trusted;

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  Linger value
) @trusted;

In a typical application, you might also want to consider using a non-blocking socket instead of setting a timeout on a blocking one.

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  Duration value
) @trusted;

Note

While the receive timeout setting is generally quite accurate on *nix systems even for smaller durations, there are two issues to be aware of on Windows: First, although undocumented, the effective timeout duration seems to be the one set on the socket plus half a second. setOption() tries to compensate for that, but still, timeouts under 500ms are not possible on Windows. Second, be aware that the actual amount of time spent until a blocking call returns randomly varies on the order of 10ms.

Parameters

Throws

SocketException if setting the options fails.

Example

import std.datetime;
auto pair = socketPair();
scope(exit) foreach (s; pair) s.close();

// Set a receive timeout, and then wait at one end of
// the socket pair, knowing that no data will arrive.
pair[0].setOption(SocketOptionLevel.SOCKET,
    SocketOption.RCVTIMEO, dur!"seconds"(1));

auto sw = StopWatch(AutoStart.yes);
ubyte[1] buffer;
pair[0].receive(buffer);
writefln("Waited %s ms until the socket timed out.",
    sw.peek.msecs);

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  void[] value
) @trusted;

Prototype

void setOption(
  SocketOptionLevel level,
  SocketOption option,
  int value
) @trusted;