From 9c255313e62699427b51fbc43b1b0ac6349363c0 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 5 Sep 2015 02:16:24 +0200 Subject: doc libmds_mpool MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/libmdsclient/inbound.c | 3 +++ src/libmdsclient/inbound.h | 3 +++ 2 files changed, 6 insertions(+) (limited to 'src') diff --git a/src/libmdsclient/inbound.c b/src/libmdsclient/inbound.c index 9f0254a..782c647 100644 --- a/src/libmdsclient/inbound.c +++ b/src/libmdsclient/inbound.c @@ -748,6 +748,9 @@ libmds_message_t* libmds_mspool_poll_try(libmds_mspool_t* restrict this, * @param this The message allocation pool * @param size The number of allocations that may be pooled * @return Zero on success, -1 on error, `errno` will be set accordingly + * + * @throws ENOMEM Out of memory. Possibly, the process hit the RLIMIT_AS or + * RLIMIT_DATA limit described in getrlimit(2). */ int libmds_mpool_initialise(libmds_mpool_t* restrict this, size_t size) { diff --git a/src/libmdsclient/inbound.h b/src/libmdsclient/inbound.h index 6080729..1dd76f3 100644 --- a/src/libmdsclient/inbound.h +++ b/src/libmdsclient/inbound.h @@ -336,6 +336,9 @@ libmds_message_t* libmds_mspool_poll_try(libmds_mspool_t* restrict this, * @param this The message allocation pool * @param size The number of allocations that may be pooled * @return Zero on success, -1 on error, `errno` will be set accordingly + * + * @throws ENOMEM Out of memory. Possibly, the process hit the RLIMIT_AS or + * RLIMIT_DATA limit described in getrlimit(2). */ __attribute__((nonnull, warn_unused_result)) int libmds_mpool_initialise(libmds_mpool_t* restrict this, size_t size); -- cgit v1.2.3-70-g09d2