From f97dc8489d58aef2d038288f9a8bc69f907e17bb Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Tue, 22 Mar 2022 19:21:58 +0100 Subject: fix(docs) fix html linter issues in the docs (#358) --- doc/udp.html | 94 ++++++++++++++++++++++++++++++------------------------------ 1 file changed, 47 insertions(+), 47 deletions(-) (limited to 'doc/udp.html') diff --git a/doc/udp.html b/doc/udp.html index 4618aad..db711cb 100644 --- a/doc/udp.html +++ b/doc/udp.html @@ -13,17 +13,17 @@ -
+
- -
-LuaSocket +
+LuaSocket
Network support for the Lua language +
Network support for the Lua language
-

+

home · download · installation · @@ -71,26 +71,26 @@ unconnected:getoption()

Gets an option value from the UDP object. -See setoption for +See setoption for description of the option names and values.

Option is a string with the option name.

    -
  • 'dontroute' -
  • 'broadcast' -
  • 'reuseaddr' -
  • 'reuseport' -
  • 'ip-multicast-loop' -
  • 'ipv6-v6only' -
  • 'ip-multicast-if' -
  • 'ip-multicast-ttl' -
  • 'ip-add-membership' -
  • 'ip-drop-membership' +
  • 'dontroute'
    • +
  • 'broadcast'
    • +
  • 'reuseaddr'
    • +
  • 'reuseport'
    • +
  • 'ip-multicast-loop'
    • +
  • 'ipv6-v6only'
    • +
  • 'ip-multicast-if'
    • +
  • 'ip-multicast-ttl'
    • +
  • 'ip-add-membership'
    • +
  • 'ip-drop-membership'

-

+

The method returns the option value in case of success, or nil followed by an error message otherwise. @@ -108,7 +108,7 @@ associated with a connected UDP object.

-

+

Returns a string with the IP address of the peer, the port number that peer is using for the connection, and a string with the family ("inet" or "inet6"). @@ -131,7 +131,7 @@ Returns the local address information associated to the object.

-

+

The method returns a string with local IP address, a number with the local port, and a string with the family ("inet" or "inet6"). @@ -148,12 +148,12 @@ wild-card address). -

+

connected:settimeout(value)
unconnected:settimeout(value)

-

+

Returns the current timeout value.

@@ -180,8 +180,8 @@ the excess bytes are discarded. If there are less then size bytes available in the current datagram, the available bytes are returned. If size is omitted, the -compile-time constant socket._DATAGRAMSIZE is used +compile-time constant +socket._DATAGRAMSIZE is used (it defaults to 8192 bytes). Larger sizes will cause a temporary buffer to be allocated for the operation.

@@ -286,45 +286,45 @@ name, and value depends on the option being set:
  • 'dontroute': Indicates that outgoing messages should bypass the standard routing facilities. -Receives a boolean value; +Receives a boolean value;
  • 'broadcast': Requests permission to send broadcast datagrams on the socket. -Receives a boolean value; +Receives a boolean value;
  • 'reuseaddr': Indicates that the rules used in validating addresses supplied in a bind() call should allow reuse of local addresses. -Receives a boolean value; +Receives a boolean value;
  • 'reuseport': Allows completely duplicate bindings by multiple processes if they all set 'reuseport' before binding the port. -Receives a boolean value; +Receives a boolean value;
  • 'ip-multicast-loop': Specifies whether or not a copy of an outgoing multicast datagram is delivered to the sending host as long as it is a member of the multicast group. -Receives a boolean value; +Receives a boolean value;
  • 'ipv6-v6only': Specifies whether to restrict inet6 sockets to sending and receiving only IPv6 packets. -Receive a boolean value; +Receive a boolean value;
  • 'ip-multicast-if': Sets the interface over which outgoing multicast datagrams are sent. -Receives an IP address; +Receives an IP address;
  • 'ip-multicast-ttl': Sets the Time To Live in the IP header for outgoing multicast datagrams. -Receives a number; +Receives a number;
  • 'ip-add-membership': Joins the multicast group specified. Receives a table with fields multiaddr and interface, each containing an -IP address; +IP address;
  • 'ip-drop-membership': Leaves the multicast group specified. Receives a table with fields multiaddr and interface, each containing an -IP address. +IP address.

@@ -332,7 +332,7 @@ The method returns 1 in case of success, or nil followed by an error message otherwise.

-

+

Note: The descriptions above come from the man pages.

@@ -381,11 +381,11 @@ is recommended when the same peer is used for several transmissions and can result in up to 30% performance gains.

-

+

Note: Starting with LuaSocket 3.0, the host name resolution depends on whether the socket was created by socket.udp or socket.udp6. Addresses from +href="#socket.udp">socket.udp or socket.udp6. Addresses from the appropriate family are tried in succession until the first success or until the last failure.

@@ -492,23 +492,23 @@ returned. In case of error, nil is returned, followed by an error message.

-

+

Note: The choice between IPv4 and IPv6 happens during a call to -sendto, setpeername, or sockname, depending on the address +sendto, setpeername, or sockname, depending on the address family obtained from the resolver.

-

+

Note: Before the choice between IPv4 and IPv6 happens, the internal socket object is invalid and therefore setoption will fail. +href="#setoption">setoption will fail.

-

+

socket.udp4()

@@ -564,7 +564,7 @@ returned. In case of error, nil is returned, followed by an error message.

-

+

Note: The TCP object returned will have the option "ipv6-v6only" set to true.

@@ -573,10 +573,10 @@ Note: The TCP object returned will have the option -
+
-

+

home · download · installation · -- cgit v1.2.3-55-g6feb