From 30ec722a3bb6dbb5d77183a8d1e369095fcc361a Mon Sep 17 00:00:00 2001 From: Diego Nehab Date: Mon, 26 Jul 2004 20:17:27 +0000 Subject: [PATCH] Added Mike's changes to udp.html. --- doc/udp.html | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/doc/udp.html b/doc/udp.html index 75d1d9e..b0c51f6 100644 --- a/doc/udp.html +++ b/doc/udp.html @@ -153,11 +153,12 @@ there are more than size bytes available in the datagram, 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 -maximum datagram size is used. +maximum datagram size is used (which is currently limited by the +implementation to 8192 bytes).

-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 nil followed by the string 'timeout'.

@@ -187,13 +188,14 @@ Sends a datagram to the UDP peer of a connected object.

Datagram 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.

If successful, the method returns 1. In case of -error, the method returns nil followed by the -'refused' message. +error, the method returns nil followed by an error message.

@@ -215,16 +217,19 @@ Sends a datagram to the specified IP address and port number.

Datagram is a string with the -datagram contents. Beware that the maximum datagram size for UDP is -576 bytes. Ip is the IP address of the recipient. Host -names are not allowed for performance reasons. +datagram contents. +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. +Ip is the IP address of the recipient. +Host names are not allowed for performance reasons. + Port is the port number at the recipient.

If successful, the method returns 1. In case of -error, the method returns nil followed by the -'refused' message. +error, the method returns nil followed by an error message.