---------------------
PatchSet 1675 
Date: 2001/02/28 14:38:09
Author: hno
Branch: eventio
Tag: (none) 
Log:
Split ncomm_read into ncomm_read and ncomm_read_limited. This because most
often one is not interested in limiting the data size of the read request.

Also cleaned up the documentation of ncomm_write somewhat, to further clarify
the order of callbacks when there is more than one queued operation.

Members: 
	doc/Programming-Guide/prog-guide.sgml:1.9.8.10->1.9.8.11 

Index: squid/doc/Programming-Guide/prog-guide.sgml
===================================================================
RCS file: /cvsroot/squid-sf//squid/doc/Programming-Guide/prog-guide.sgml,v
retrieving revision 1.9.8.10
retrieving revision 1.9.8.11
diff -u -r1.9.8.10 -r1.9.8.11
--- squid/doc/Programming-Guide/prog-guide.sgml	25 Feb 2001 22:15:24 -0000	1.9.8.10
+++ squid/doc/Programming-Guide/prog-guide.sgml	28 Feb 2001 14:38:09 -0000	1.9.8.11
@@ -2,7 +2,7 @@
 <article>
 <title>Squid Programmers Guide</title>
 <author>Duane Wessels, Squid Developers
-<date>$Id: prog-guide.sgml,v 1.9.8.10 2001/02/25 22:15:24 hno Exp $</date>
+<date>$Id: prog-guide.sgml,v 1.9.8.11 2001/02/28 14:38:09 hno Exp $</date>
 
 <abstract>
 Squid is a WWW Cache application developed by the National Laboratory
@@ -3117,17 +3117,20 @@
 
 <p><verb>
 	void
-	ncomm_read(filehandle *fh, size_t max_size, COMMIOCB *callback,
+	ncomm_read(filehandle *fh, COMMIOCB *callback, void *cbdata);
+	void
+	ncomm_read_limited(filehandle *fh, size_t max_size, COMMIOCB *callback,
 		   void *cbdata);
 </verb>
 
 <p>
-	Reads at least min_size or at most max_size of data from the
-	connection and adds it to the specified IOBUF
-
+	Request to write data. The callback will be called when
+	the request has finished, or if an unrecoverable error
+	occurs.
+	
 <p>
-	buf might be specified as NULL in which case a new IOBUF will be
-	allocated to for the data read from the network.
+	ncomm_read_limited can limit the max amount of data read in
+	one request.
 
 <p>
 	Any errors will be signalled to the callback function.
@@ -3141,14 +3144,14 @@
 </verb>
 
 <p>
-	request to write data. The callback will be called when
+	Request to write data. The callback will be called when
 	the request has finished, or if an unrecoverable error
 	occurs.
 
 <p>
 	it is allowable to queue more write requests before the first has
 	finished. The requests will be processed and completed in the order
-	requested without reordering.
+	requested without reordering in data or callback order.
 
 <p>
 	Any errors will be signalled to the callback function.