dany/luasocket
1
0
Fork 0
mirror of https://github.com/lunarmodules/luasocket.git synced 2024-07-03 11:49:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Added Mike's changes to udp.html.

Browse Source
This commit is contained in:
Diego Nehab 2004-07-26 20:17:27 +00:00
parent b1c1b616dc
commit 30ec722a3b
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/udp.html
View File

@ -153,11 +153,12 @@ there are more than <tt>size</tt> bytes available in the datagram,
the excess bytes are discarded. If there are less then the excess bytes are discarded. If there are less then
<tt>size</tt> bytes available in the current datagram, the <tt>size</tt> bytes available in the current datagram, the
available bytes are returned. If <tt>size</tt> is omitted, the available bytes are returned. If <tt>size</tt> is omitted, the
maximum datagram size is used. maximum datagram size is used (which is currently limited by the
implementation to 8192 bytes).
</p> </p>
<p class="return"> <p class="return">
In case of success, the method return the In case of success, the method returns the
received datagram. In case of timeout, the method returns received datagram. In case of timeout, the method returns
<b><tt>nil</tt></b> followed by the string '<tt>timeout</tt>'. <b><tt>nil</tt></b> followed by the string '<tt>timeout</tt>'.
</p> </p>
@ -187,13 +188,14 @@ Sends a datagram to the UDP peer of a connected object.
<p class="parameters"> <p class="parameters">
<tt>Datagram</tt> is a string with the datagram contents. <tt>Datagram</tt> is a string with the datagram contents.
Beware that the maximum datagram size for UDP is 576 bytes. The maximum datagram size for UDP is 64K minus IP layer overhead.
However datagrams larger than the link layer packet size will be
fragmented, which may deteriorate performance and/or reliability.
</p> </p>
<p class="return"> <p class="return">
If successful, the method returns 1. In case of If successful, the method returns 1. In case of
error, the method returns <b><tt>nil</tt></b> followed by the error, the method returns <b><tt>nil</tt></b> followed by an error message.
'<tt>refused</tt>' message.
</p> </p>
<p class="note"> <p class="note">
@ -215,16 +217,19 @@ Sends a datagram to the specified IP address and port number.
<p class="parameters"> <p class="parameters">
<tt>Datagram</tt> is a string with the <tt>Datagram</tt> is a string with the
datagram contents. Beware that the maximum datagram size for UDP is datagram contents.
576 bytes. <tt>Ip</tt> is the IP address of the recipient. Host The maximum datagram size for UDP is 64K minus IP layer overhead.
names are <em>not</em> allowed for performance reasons. However datagrams larger than the link layer packet size will be
fragmented, which may deteriorate performance and/or reliability.
<tt>Ip</tt> is the IP address of the recipient.
Host names are <em>not</em> allowed for performance reasons.
<tt>Port</tt> is the port number at the recipient. <tt>Port</tt> is the port number at the recipient.
</p> </p>
<p class="return"> <p class="return">
If successful, the method returns 1. In case of If successful, the method returns 1. In case of
error, the method returns <b><tt>nil</tt></b> followed by the error, the method returns <b><tt>nil</tt></b> followed by an error message.
'<tt>refused</tt>' message.
</p> </p>
<p class="note"> <p class="note">