stas 2003/11/06 12:20:26
Modified: src/modules/perl modperl_io_apache.h
Log:
add a doxygen doc for modperl_request_read
Revision Changes Path
1.3 +12 -0 modperl-2.0/src/modules/perl/modperl_io_apache.h
Index: modperl_io_apache.h
===================================================================
RCS file: /home/cvs/modperl-2.0/src/modules/perl/modperl_io_apache.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- modperl_io_apache.h 6 Nov 2003 11:22:02 -0000 1.2
+++ modperl_io_apache.h 6 Nov 2003 20:20:26 -0000 1.3
@@ -26,6 +26,18 @@
#endif /* #ifdef PERLIO_LAYERS */
+/**
+ * read 'len' bytes from the request record 'r' into 'buffer'
+ *
+ * this call will block until all 'len' bytes are read, eof is reached
+ * or will return an error otherwise
+ *
+ * @param r request record
+ * @param buffer preallocated buffer of size 'len' to store the data in
+ * @param len how many bytes to read
+ * @return how many bytes were read,
+ * -1 on error (in which case ERRSV ($!) is set)
+ */
MP_INLINE SSize_t modperl_request_read(pTHX_ request_rec *r,
char *buffer, Size_t len);
