* @file include/gnunet_bio_lib.h
* @brief buffered IO API
* @author Christian Grothoff
+ * @defgroup bio Buffered binary disk IO (with endianess conversion)
+ * @{
*/
#ifndef GNUNET_BIO_LIB_H
#endif
/**
+ * @ingroup bio
* Handle for buffered reading.
*/
struct GNUNET_BIO_ReadHandle;
*
* @param h file handle
* @param emsg set to the error message
- * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
*/
int
GNUNET_BIO_read_close (struct GNUNET_BIO_ReadHandle *h, char **emsg);
* @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
-GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h, const char *file, int line,
+GNUNET_BIO_read_fn (struct GNUNET_BIO_ReadHandle *h,
+ const char *file, int line,
void *result, size_t len);
/**
* @param what describes what is being read (for error message creation)
* @param result the buffer to store a pointer to the (allocated) string to
* (note that *result could be set to NULL as well)
- * @param maxLen maximum allowed length for the string
+ * @param max_length maximum allowed length for the string
* @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
GNUNET_BIO_read_string (struct GNUNET_BIO_ReadHandle *h, const char *what,
- char **result, size_t maxLen);
+ char **result, size_t max_length);
/**
*
* @param h hande to open file
* @param i 32-bit integer to write
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_BIO_write_int32 (struct GNUNET_BIO_WriteHandle *h, int32_t i);
}
#endif
+/** @} */ /* end of group bio */
+
/* ifndef GNUNET_BIO_LIB_H */
#endif
/* end of gnunet_bio_lib.h */