[svn] assuan - r340 - trunk/src

[svn author marcus]

Author: marcus
Date: 2010-01-05 05:07:48 +0100 (Tue, 05 Jan 2010)
New Revision: 340

Modified:
   trunk/src/assuan-buffer.c
Log:
Add comments.


Modified: trunk/src/assuan-buffer.c
===================================================================
--- trunk/src/assuan-buffer.c	2009-12-22 13:01:21 UTC (rev 339)
+++ trunk/src/assuan-buffer.c	2010-01-05 04:07:48 UTC (rev 340)
@@ -31,7 +31,11 @@
 
 
 /* Extended version of write(2) to guarantee that all bytes are
-   written.  Returns 0 on success or -1 and ERRNO on failure. */
+   written.  Returns 0 on success or -1 and ERRNO on failure.  NOTE:
+   This function does not return the number of bytes written, so any
+   error must be treated as fatal for this connection as the state of
+   the receiver is unknown.  This works best if blocking is allowed
+   (so EAGAIN cannot occur).  */
 static int
 writen (assuan_context_t ctx, const char *buffer, size_t length)
 {
@@ -93,7 +97,8 @@
 }
 
 
-/* Function returns an Assuan error.  */
+/* Read a line with buffering of partial lines.  Function returns an
+   Assuan error.  */
 gpg_error_t
 _assuan_read_line (assuan_context_t ctx)
 {