diff options
Diffstat (limited to 'doc/udp.html')
| -rw-r--r-- | doc/udp.html | 431 |
1 files changed, 223 insertions, 208 deletions
diff --git a/doc/udp.html b/doc/udp.html index 9437c51..4618aad 100644 --- a/doc/udp.html +++ b/doc/udp.html | |||
| @@ -39,112 +39,6 @@ | |||
| 39 | 39 | ||
| 40 | <h2 id="udp">UDP</h2> | 40 | <h2 id="udp">UDP</h2> |
| 41 | 41 | ||
| 42 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 43 | |||
| 44 | <p class="name" id="socket.udp"> | ||
| 45 | socket.<b>udp()</b> | ||
| 46 | </p> | ||
| 47 | |||
| 48 | <p class="description"> | ||
| 49 | Creates and returns an unconnected UDP object. | ||
| 50 | Unconnected objects support the | ||
| 51 | <a href="#sendto"><tt>sendto</tt></a>, | ||
| 52 | <a href="#receive"><tt>receive</tt></a>, | ||
| 53 | <a href="#receivefrom"><tt>receivefrom</tt></a>, | ||
| 54 | <a href="#getoption"><tt>getoption</tt></a>, | ||
| 55 | <a href="#getsockname"><tt>getsockname</tt></a>, | ||
| 56 | <a href="#setoption"><tt>setoption</tt></a>, | ||
| 57 | <a href="#settimeout"><tt>settimeout</tt></a>, | ||
| 58 | <a href="#setpeername"><tt>setpeername</tt></a>, | ||
| 59 | <a href="#setsockname"><tt>setsockname</tt></a>, and | ||
| 60 | <a href="#close"><tt>close</tt></a>. | ||
| 61 | The <a href="#setpeername"><tt>setpeername</tt></a> | ||
| 62 | is used to connect the object. | ||
| 63 | </p> | ||
| 64 | |||
| 65 | <p class="return"> | ||
| 66 | In case of success, a new unconnected UDP object | ||
| 67 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | ||
| 68 | an error message. | ||
| 69 | </p> | ||
| 70 | |||
| 71 | <p class=note> | ||
| 72 | Note: The choice between IPv4 and IPv6 happens during a call to | ||
| 73 | <a href=#sendto><tt>sendto</tt></a>, <a | ||
| 74 | href=#setpeername><tt>setpeername</tt></a>, or <a | ||
| 75 | href=#setsockname><tt>sockname</tt></a>, depending on the address | ||
| 76 | family obtained from the resolver. | ||
| 77 | </p> | ||
| 78 | |||
| 79 | <p class=note> | ||
| 80 | Note: Before the choice between IPv4 and IPv6 happens, | ||
| 81 | the internal socket object is invalid and therefore <a | ||
| 82 | href=#setoption><tt>setoption</tt></a> will fail. | ||
| 83 | </p> | ||
| 84 | |||
| 85 | <!-- socket.udp4 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 86 | |||
| 87 | <p class="name" id="socket.udp"> | ||
| 88 | socket.<b>udp4()</b> | ||
| 89 | </p> | ||
| 90 | |||
| 91 | <p class="description"> | ||
| 92 | Creates and returns an unconnected IPv4 UDP object. | ||
| 93 | Unconnected objects support the | ||
| 94 | <a href="#sendto"><tt>sendto</tt></a>, | ||
| 95 | <a href="#receive"><tt>receive</tt></a>, | ||
| 96 | <a href="#receivefrom"><tt>receivefrom</tt></a>, | ||
| 97 | <a href="#getoption"><tt>getoption</tt></a>, | ||
| 98 | <a href="#getsockname"><tt>getsockname</tt></a>, | ||
| 99 | <a href="#setoption"><tt>setoption</tt></a>, | ||
| 100 | <a href="#settimeout"><tt>settimeout</tt></a>, | ||
| 101 | <a href="#setpeername"><tt>setpeername</tt></a>, | ||
| 102 | <a href="#setsockname"><tt>setsockname</tt></a>, and | ||
| 103 | <a href="#close"><tt>close</tt></a>. | ||
| 104 | The <a href="#setpeername"><tt>setpeername</tt></a> | ||
| 105 | is used to connect the object. | ||
| 106 | </p> | ||
| 107 | |||
| 108 | <p class="return"> | ||
| 109 | In case of success, a new unconnected UDP object | ||
| 110 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | ||
| 111 | an error message. | ||
| 112 | </p> | ||
| 113 | |||
| 114 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 115 | |||
| 116 | <p class="name" id="socket.udp6"> | ||
| 117 | socket.<b>udp6()</b> | ||
| 118 | </p> | ||
| 119 | |||
| 120 | <p class="description"> | ||
| 121 | Creates and returns an unconnected IPv6 UDP object. | ||
| 122 | Unconnected objects support the | ||
| 123 | <a href="#sendto"><tt>sendto</tt></a>, | ||
| 124 | <a href="#receive"><tt>receive</tt></a>, | ||
| 125 | <a href="#receivefrom"><tt>receivefrom</tt></a>, | ||
| 126 | <a href="#getoption"><tt>getoption</tt></a>, | ||
| 127 | <a href="#getsockname"><tt>getsockname</tt></a>, | ||
| 128 | <a href="#setoption"><tt>setoption</tt></a>, | ||
| 129 | <a href="#settimeout"><tt>settimeout</tt></a>, | ||
| 130 | <a href="#setpeername"><tt>setpeername</tt></a>, | ||
| 131 | <a href="#setsockname"><tt>setsockname</tt></a>, and | ||
| 132 | <a href="#close"><tt>close</tt></a>. | ||
| 133 | The <a href="#setpeername"><tt>setpeername</tt></a> | ||
| 134 | is used to connect the object. | ||
| 135 | </p> | ||
| 136 | |||
| 137 | <p class="return"> | ||
| 138 | In case of success, a new unconnected UDP object | ||
| 139 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | ||
| 140 | an error message. | ||
| 141 | </p> | ||
| 142 | |||
| 143 | <p class=note> | ||
| 144 | Note: The TCP object returned will have the option | ||
| 145 | "<tt>ipv6-v6only</tt>" set to <tt><b>true</b></tt>. | ||
| 146 | </p> | ||
| 147 | |||
| 148 | <!-- close +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 42 | <!-- close +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 149 | 43 | ||
| 150 | <p class="name" id="close"> | 44 | <p class="name" id="close"> |
| @@ -168,6 +62,40 @@ Garbage-collected objects are automatically closed before | |||
| 168 | destruction, though. | 62 | destruction, though. |
| 169 | </p> | 63 | </p> |
| 170 | 64 | ||
| 65 | <!-- getoption +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 66 | |||
| 67 | <p class="name" id="getoption"> | ||
| 68 | connected:<b>getoption()</b><br> | ||
| 69 | unconnected:<b>getoption()</b> | ||
| 70 | </p> | ||
| 71 | |||
| 72 | <p class="description"> | ||
| 73 | Gets an option value from the UDP object. | ||
| 74 | See <a href=#setoption><tt>setoption</tt></a> for | ||
| 75 | description of the option names and values. | ||
| 76 | </p> | ||
| 77 | |||
| 78 | <p class="parameters"><tt>Option</tt> is a string with the option name. | ||
| 79 | <ul> | ||
| 80 | <li> '<tt>dontroute</tt>' | ||
| 81 | <li> '<tt>broadcast</tt>' | ||
| 82 | <li> '<tt>reuseaddr</tt>' | ||
| 83 | <li> '<tt>reuseport</tt>' | ||
| 84 | <li> '<tt>ip-multicast-loop</tt>' | ||
| 85 | <li> '<tt>ipv6-v6only</tt>' | ||
| 86 | <li> '<tt>ip-multicast-if</tt>' | ||
| 87 | <li> '<tt>ip-multicast-ttl</tt>' | ||
| 88 | <li> '<tt>ip-add-membership</tt>' | ||
| 89 | <li> '<tt>ip-drop-membership</tt>' | ||
| 90 | </ul> | ||
| 91 | </p> | ||
| 92 | |||
| 93 | <p class=return> | ||
| 94 | The method returns the option <tt>value</tt> in case of | ||
| 95 | success, or | ||
| 96 | <b><tt>nil</tt></b> followed by an error message otherwise. | ||
| 97 | </p> | ||
| 98 | |||
| 171 | <!-- getpeername +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 99 | <!-- getpeername +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 172 | 100 | ||
| 173 | <p class="name" id="getpeername"> | 101 | <p class="name" id="getpeername"> |
| @@ -218,6 +146,18 @@ first time (in which case it is bound to an ephemeral port and the | |||
| 218 | wild-card address). | 146 | wild-card address). |
| 219 | </p> | 147 | </p> |
| 220 | 148 | ||
| 149 | <!-- gettimeout +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 150 | |||
| 151 | <p class=name id="gettimeout"> | ||
| 152 | connected:<b>settimeout(</b>value<b>)</b><br> | ||
| 153 | unconnected:<b>settimeout(</b>value<b>)</b> | ||
| 154 | </p> | ||
| 155 | |||
| 156 | <p class=description> | ||
| 157 | Returns the current timeout value. | ||
| 158 | </p> | ||
| 159 | |||
| 160 | |||
| 221 | <!-- receive +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 161 | <!-- receive +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 222 | 162 | ||
| 223 | <p class="name" id="receive"> | 163 | <p class="name" id="receive"> |
| @@ -265,40 +205,6 @@ address and port as extra return values (and is therefore slightly less | |||
| 265 | efficient). | 205 | efficient). |
| 266 | </p> | 206 | </p> |
| 267 | 207 | ||
| 268 | <!-- getoption +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 269 | |||
| 270 | <p class="name" id="getoption"> | ||
| 271 | connected:<b>getoption()</b><br> | ||
| 272 | unconnected:<b>getoption()</b> | ||
| 273 | </p> | ||
| 274 | |||
| 275 | <p class="description"> | ||
| 276 | Gets an option value from the UDP object. | ||
| 277 | See <a href=#setoption><tt>setoption</tt></a> for | ||
| 278 | description of the option names and values. | ||
| 279 | </p> | ||
| 280 | |||
| 281 | <p class="parameters"><tt>Option</tt> is a string with the option name. | ||
| 282 | <ul> | ||
| 283 | <li> '<tt>dontroute</tt>' | ||
| 284 | <li> '<tt>broadcast</tt>' | ||
| 285 | <li> '<tt>reuseaddr</tt>' | ||
| 286 | <li> '<tt>reuseport</tt>' | ||
| 287 | <li> '<tt>ip-multicast-loop</tt>' | ||
| 288 | <li> '<tt>ipv6-v6only</tt>' | ||
| 289 | <li> '<tt>ip-multicast-if</tt>' | ||
| 290 | <li> '<tt>ip-multicast-ttl</tt>' | ||
| 291 | <li> '<tt>ip-add-membership</tt>' | ||
| 292 | <li> '<tt>ip-drop-membership</tt>' | ||
| 293 | </ul> | ||
| 294 | </p> | ||
| 295 | |||
| 296 | <p class=return> | ||
| 297 | The method returns the option <tt>value</tt> in case of | ||
| 298 | success, or | ||
| 299 | <b><tt>nil</tt></b> followed by an error message otherwise. | ||
| 300 | </p> | ||
| 301 | |||
| 302 | <!-- send ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 208 | <!-- send ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 303 | 209 | ||
| 304 | <p class="name" id="send"> | 210 | <p class="name" id="send"> |
| @@ -362,6 +268,75 @@ refuses to send a message to the specified address (i.e. no | |||
| 362 | interface accepts the address). | 268 | interface accepts the address). |
| 363 | </p> | 269 | </p> |
| 364 | 270 | ||
| 271 | <!-- setoption +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 272 | |||
| 273 | <p class="name" id="setoption"> | ||
| 274 | connected:<b>setoption(</b>option [, value]<b>)</b><br> | ||
| 275 | unconnected:<b>setoption(</b>option [, value]<b>)</b> | ||
| 276 | </p> | ||
| 277 | |||
| 278 | <p class="description"> | ||
| 279 | Sets options for the UDP object. Options are | ||
| 280 | only needed by low-level or time-critical applications. You should | ||
| 281 | only modify an option if you are sure you need it.</p> | ||
| 282 | <p class="parameters"><tt>Option</tt> is a string with the option | ||
| 283 | name, and <tt>value</tt> depends on the option being set: | ||
| 284 | </p> | ||
| 285 | |||
| 286 | <ul> | ||
| 287 | <li> '<tt>dontroute</tt>': Indicates that outgoing | ||
| 288 | messages should bypass the standard routing facilities. | ||
| 289 | Receives a boolean value; | ||
| 290 | <li> '<tt>broadcast</tt>': Requests permission to send | ||
| 291 | broadcast datagrams on the socket. | ||
| 292 | Receives a boolean value; | ||
| 293 | <li> '<tt>reuseaddr</tt>': Indicates that the rules used in | ||
| 294 | validating addresses supplied in a <tt>bind()</tt> call | ||
| 295 | should allow reuse of local addresses. | ||
| 296 | Receives a boolean value; | ||
| 297 | <li> '<tt>reuseport</tt>': Allows completely duplicate | ||
| 298 | bindings by multiple processes if they all set | ||
| 299 | '<tt>reuseport</tt>' before binding the port. | ||
| 300 | Receives a boolean value; | ||
| 301 | <li> '<tt>ip-multicast-loop</tt>': | ||
| 302 | Specifies whether or not a copy of an outgoing multicast | ||
| 303 | datagram is delivered to the sending host as long as it is a | ||
| 304 | member of the multicast group. | ||
| 305 | Receives a boolean value; | ||
| 306 | <li> '<tt>ipv6-v6only</tt>': | ||
| 307 | Specifies whether to restrict <tt>inet6</tt> sockets to | ||
| 308 | sending and receiving only IPv6 packets. | ||
| 309 | Receive a boolean value; | ||
| 310 | <li> '<tt>ip-multicast-if</tt>': | ||
| 311 | Sets the interface over which outgoing multicast datagrams | ||
| 312 | are sent. | ||
| 313 | Receives an IP address; | ||
| 314 | <li> '<tt>ip-multicast-ttl</tt>': | ||
| 315 | Sets the Time To Live in the IP header for outgoing | ||
| 316 | multicast datagrams. | ||
| 317 | Receives a number; | ||
| 318 | <li> '<tt>ip-add-membership</tt>': | ||
| 319 | Joins the multicast group specified. | ||
| 320 | Receives a table with fields | ||
| 321 | <tt>multiaddr</tt> and <tt>interface</tt>, each containing an | ||
| 322 | IP address; | ||
| 323 | <li> '<tt>ip-drop-membership</tt>': Leaves the multicast | ||
| 324 | group specified. | ||
| 325 | Receives a table with fields | ||
| 326 | <tt>multiaddr</tt> and <tt>interface</tt>, each containing an | ||
| 327 | IP address. | ||
| 328 | </ul> | ||
| 329 | |||
| 330 | <p class="return"> | ||
| 331 | The method returns 1 in case of success, or | ||
| 332 | <b><tt>nil</tt></b> followed by an error message otherwise. | ||
| 333 | </p> | ||
| 334 | |||
| 335 | <p class=note> | ||
| 336 | Note: The descriptions above come from the man pages. | ||
| 337 | </p> | ||
| 338 | |||
| 339 | |||
| 365 | <!-- setpeername +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 340 | <!-- setpeername +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 366 | 341 | ||
| 367 | <p class="name" id="setpeername"> | 342 | <p class="name" id="setpeername"> |
| @@ -448,74 +423,6 @@ system or explicitly by <tt>setsockname</tt>, it cannot be | |||
| 448 | changed. | 423 | changed. |
| 449 | </p> | 424 | </p> |
| 450 | 425 | ||
| 451 | <!-- setoption +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 452 | |||
| 453 | <p class="name" id="setoption"> | ||
| 454 | connected:<b>setoption(</b>option [, value]<b>)</b><br> | ||
| 455 | unconnected:<b>setoption(</b>option [, value]<b>)</b> | ||
| 456 | </p> | ||
| 457 | |||
| 458 | <p class="description"> | ||
| 459 | Sets options for the UDP object. Options are | ||
| 460 | only needed by low-level or time-critical applications. You should | ||
| 461 | only modify an option if you are sure you need it.</p> | ||
| 462 | <p class="parameters"><tt>Option</tt> is a string with the option | ||
| 463 | name, and <tt>value</tt> depends on the option being set: | ||
| 464 | </p> | ||
| 465 | |||
| 466 | <ul> | ||
| 467 | <li> '<tt>dontroute</tt>': Indicates that outgoing | ||
| 468 | messages should bypass the standard routing facilities. | ||
| 469 | Receives a boolean value; | ||
| 470 | <li> '<tt>broadcast</tt>': Requests permission to send | ||
| 471 | broadcast datagrams on the socket. | ||
| 472 | Receives a boolean value; | ||
| 473 | <li> '<tt>reuseaddr</tt>': Indicates that the rules used in | ||
| 474 | validating addresses supplied in a <tt>bind()</tt> call | ||
| 475 | should allow reuse of local addresses. | ||
| 476 | Receives a boolean value; | ||
| 477 | <li> '<tt>reuseport</tt>': Allows completely duplicate | ||
| 478 | bindings by multiple processes if they all set | ||
| 479 | '<tt>reuseport</tt>' before binding the port. | ||
| 480 | Receives a boolean value; | ||
| 481 | <li> '<tt>ip-multicast-loop</tt>': | ||
| 482 | Specifies whether or not a copy of an outgoing multicast | ||
| 483 | datagram is delivered to the sending host as long as it is a | ||
| 484 | member of the multicast group. | ||
| 485 | Receives a boolean value; | ||
| 486 | <li> '<tt>ipv6-v6only</tt>': | ||
| 487 | Specifies whether to restrict <tt>inet6</tt> sockets to | ||
| 488 | sending and receiving only IPv6 packets. | ||
| 489 | Receive a boolean value; | ||
| 490 | <li> '<tt>ip-multicast-if</tt>': | ||
| 491 | Sets the interface over which outgoing multicast datagrams | ||
| 492 | are sent. | ||
| 493 | Receives an IP address; | ||
| 494 | <li> '<tt>ip-multicast-ttl</tt>': | ||
| 495 | Sets the Time To Live in the IP header for outgoing | ||
| 496 | multicast datagrams. | ||
| 497 | Receives a number; | ||
| 498 | <li> '<tt>ip-add-membership</tt>': | ||
| 499 | Joins the multicast group specified. | ||
| 500 | Receives a table with fields | ||
| 501 | <tt>multiaddr</tt> and <tt>interface</tt>, each containing an | ||
| 502 | IP address; | ||
| 503 | <li> '<tt>ip-drop-membership</tt>': Leaves the multicast | ||
| 504 | group specified. | ||
| 505 | Receives a table with fields | ||
| 506 | <tt>multiaddr</tt> and <tt>interface</tt>, each containing an | ||
| 507 | IP address. | ||
| 508 | </ul> | ||
| 509 | |||
| 510 | <p class="return"> | ||
| 511 | The method returns 1 in case of success, or | ||
| 512 | <b><tt>nil</tt></b> followed by an error message otherwise. | ||
| 513 | </p> | ||
| 514 | |||
| 515 | <p class=note> | ||
| 516 | Note: The descriptions above come from the man pages. | ||
| 517 | </p> | ||
| 518 | |||
| 519 | <!-- settimeout +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 426 | <!-- settimeout +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 520 | 427 | ||
| 521 | <p class="name" id="settimeout"> | 428 | <p class="name" id="settimeout"> |
| @@ -556,6 +463,114 @@ all other method names already contained verbs making their | |||
| 556 | imperative nature obvious. | 463 | imperative nature obvious. |
| 557 | </p> | 464 | </p> |
| 558 | 465 | ||
| 466 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 467 | |||
| 468 | <p class="name" id="socket.udp"> | ||
| 469 | socket.<b>udp()</b> | ||
| 470 | </p> | ||
| 471 | |||
| 472 | <p class="description"> | ||
| 473 | Creates and returns an unconnected UDP object. | ||
| 474 | Unconnected objects support the | ||
| 475 | <a href="#sendto"><tt>sendto</tt></a>, | ||
| 476 | <a href="#receive"><tt>receive</tt></a>, | ||
| 477 | <a href="#receivefrom"><tt>receivefrom</tt></a>, | ||
| 478 | <a href="#getoption"><tt>getoption</tt></a>, | ||
| 479 | <a href="#getsockname"><tt>getsockname</tt></a>, | ||
| 480 | <a href="#setoption"><tt>setoption</tt></a>, | ||
| 481 | <a href="#settimeout"><tt>settimeout</tt></a>, | ||
| 482 | <a href="#setpeername"><tt>setpeername</tt></a>, | ||
| 483 | <a href="#setsockname"><tt>setsockname</tt></a>, and | ||
| 484 | <a href="#close"><tt>close</tt></a>. | ||
| 485 | The <a href="#setpeername"><tt>setpeername</tt></a> | ||
| 486 | is used to connect the object. | ||
| 487 | </p> | ||
| 488 | |||
| 489 | <p class="return"> | ||
| 490 | In case of success, a new unconnected UDP object | ||
| 491 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | ||
| 492 | an error message. | ||
| 493 | </p> | ||
| 494 | |||
| 495 | <p class=note> | ||
| 496 | Note: The choice between IPv4 and IPv6 happens during a call to | ||
| 497 | <a href=#sendto><tt>sendto</tt></a>, <a | ||
| 498 | href=#setpeername><tt>setpeername</tt></a>, or <a | ||
| 499 | href=#setsockname><tt>sockname</tt></a>, depending on the address | ||
| 500 | family obtained from the resolver. | ||
| 501 | </p> | ||
| 502 | |||
| 503 | <p class=note> | ||
| 504 | Note: Before the choice between IPv4 and IPv6 happens, | ||
| 505 | the internal socket object is invalid and therefore <a | ||
| 506 | href=#setoption><tt>setoption</tt></a> will fail. | ||
| 507 | </p> | ||
| 508 | |||
| 509 | <!-- socket.udp4 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 510 | |||
| 511 | <p class="name" id="socket.udp"> | ||
| 512 | socket.<b>udp4()</b> | ||
| 513 | </p> | ||
| 514 | |||
| 515 | <p class="description"> | ||
| 516 | Creates and returns an unconnected IPv4 UDP object. | ||
| 517 | Unconnected objects support the | ||
| 518 | <a href="#sendto"><tt>sendto</tt></a>, | ||
| 519 | <a href="#receive"><tt>receive</tt></a>, | ||
| 520 | <a href="#receivefrom"><tt>receivefrom</tt></a>, | ||
| 521 | <a href="#getoption"><tt>getoption</tt></a>, | ||
| 522 | <a href="#getsockname"><tt>getsockname</tt></a>, | ||
| 523 | <a href="#setoption"><tt>setoption</tt></a>, | ||
| 524 | <a href="#settimeout"><tt>settimeout</tt></a>, | ||
| 525 | <a href="#setpeername"><tt>setpeername</tt></a>, | ||
| 526 | <a href="#setsockname"><tt>setsockname</tt></a>, and | ||
| 527 | <a href="#close"><tt>close</tt></a>. | ||
| 528 | The <a href="#setpeername"><tt>setpeername</tt></a> | ||
| 529 | is used to connect the object. | ||
| 530 | </p> | ||
| 531 | |||
| 532 | <p class="return"> | ||
| 533 | In case of success, a new unconnected UDP object | ||
| 534 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | ||
| 535 | an error message. | ||
| 536 | </p> | ||
| 537 | |||
| 538 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 539 | |||
| 540 | <p class="name" id="socket.udp6"> | ||
| 541 | socket.<b>udp6()</b> | ||
| 542 | </p> | ||
| 543 | |||
| 544 | <p class="description"> | ||
| 545 | Creates and returns an unconnected IPv6 UDP object. | ||
| 546 | Unconnected objects support the | ||
| 547 | <a href="#sendto"><tt>sendto</tt></a>, | ||
| 548 | <a href="#receive"><tt>receive</tt></a>, | ||
| 549 | <a href="#receivefrom"><tt>receivefrom</tt></a>, | ||
| 550 | <a href="#getoption"><tt>getoption</tt></a>, | ||
| 551 | <a href="#getsockname"><tt>getsockname</tt></a>, | ||
| 552 | <a href="#setoption"><tt>setoption</tt></a>, | ||
| 553 | <a href="#settimeout"><tt>settimeout</tt></a>, | ||
| 554 | <a href="#setpeername"><tt>setpeername</tt></a>, | ||
| 555 | <a href="#setsockname"><tt>setsockname</tt></a>, and | ||
| 556 | <a href="#close"><tt>close</tt></a>. | ||
| 557 | The <a href="#setpeername"><tt>setpeername</tt></a> | ||
| 558 | is used to connect the object. | ||
| 559 | </p> | ||
| 560 | |||
| 561 | <p class="return"> | ||
| 562 | In case of success, a new unconnected UDP object | ||
| 563 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | ||
| 564 | an error message. | ||
| 565 | </p> | ||
| 566 | |||
| 567 | <p class=note> | ||
| 568 | Note: The TCP object returned will have the option | ||
| 569 | "<tt>ipv6-v6only</tt>" set to <tt><b>true</b></tt>. | ||
| 570 | </p> | ||
| 571 | |||
| 572 | |||
| 573 | |||
| 559 | <!-- footer ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 574 | <!-- footer ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 560 | 575 | ||
| 561 | <div class=footer> | 576 | <div class=footer> |
