From a9a1e25fdec1faba0237a554027a0f717f132c51 Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Sun, 30 Aug 2026 15:58:20 +0200 Subject: chore(docs): add docs for SO_EXCLUSIVEADDRUSE and others Adds docs for the option, but also adds the docs for other options present in the code but missing from the docs. --- docs/tcp.html | 31 ++++++++++++++++++++++++++++++- docs/udp.html | 45 +++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 71 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/tcp.html b/docs/tcp.html index a26228d..d223abf 100644 --- a/docs/tcp.html +++ b/docs/tcp.html @@ -236,10 +236,20 @@ option names and values.

Option is a string with the option name.

@@ -456,6 +466,11 @@ depends on the option being set:

diff --git a/docs/udp.html b/docs/udp.html index 99613b8..8d807a4 100644 --- a/docs/udp.html +++ b/docs/udp.html @@ -80,13 +80,18 @@ description of the option names and values.

  • 'dontroute'
  • 'broadcast'
  • 'reuseaddr'
    • +
  • 'exclusiveaddruse'
  • 'reuseport'
  • 'ip-multicast-loop'
  • 'ipv6-v6only'
    • +
  • 'ipv6-unicast-hops'
    • +
  • 'ipv6-multicast-hops'
    • +
  • 'ipv6-multicast-loop'
  • 'ip-multicast-if'
    • -
  • 'ip-multicast-ttl'
    • -
  • 'ip-add-membership'
    • -
  • 'ip-drop-membership'
    • +
  • 'error': Returns the socket's pending error status, if +any, and clears it. Get-only.
    • +
  • 'recv-buffer-size'
    • +
  • 'send-buffer-size'

    • @@ -294,6 +299,10 @@ Receives a boolean value; validating addresses supplied in a bind() call should allow reuse of local addresses. Receives a boolean value; +
  • 'exclusiveaddruse': Setting this option to true +prevents other sockets from binding to the same address and port, even +if those sockets set 'reuseaddr'. +Receives a boolean value. Windows only!!
  • 'reuseport': Allows completely duplicate bindings by multiple processes if they all set 'reuseport' before binding the port. @@ -307,6 +316,28 @@ Receives a boolean value;
    • Specifies whether to restrict inet6 sockets to sending and receiving only IPv6 packets. Receive a boolean value; +
  • 'ipv6-unicast-hops': +Sets the unicast hop limit (the IPv6 equivalent of the IPv4 TTL) +for outgoing packets. +Receives a number;
    • +
  • 'ipv6-multicast-hops': +Sets the hop limit for outgoing IPv6 multicast datagrams. +Receives a number;
    • +
  • 'ipv6-multicast-loop': +Specifies whether or not a copy of an outgoing IPv6 multicast +datagram is delivered to the sending host as long as it is a +member of the multicast group. +Receives a boolean value;
    • +
  • 'ipv6-add-membership': +Joins the IPv6 multicast group specified. +Receives a table with field +multiaddr, an IPv6 address, and optionally +interface, a network interface index number;
    • +
  • 'ipv6-drop-membership': Leaves the IPv6 multicast +group specified. +Receives a table with field +multiaddr, an IPv6 address, and optionally +interface, a network interface index number;
  • 'ip-multicast-if': Sets the interface over which outgoing multicast datagrams are sent. @@ -324,7 +355,13 @@ IP address;
    • group specified. Receives a table with fields multiaddr and interface, each containing an -IP address. +IP address; +
  • 'recv-buffer-size': Sets the size, in bytes, of the +socket's receive buffer (SO_RCVBUF). +Receives a number;
    • +
  • 'send-buffer-size': Sets the size, in bytes, of the +socket's send buffer (SO_SNDBUF). +Receives a number.

    • -- cgit v1.2.3-55-g6feb