aboutsummaryrefslogtreecommitdiffstats
path: root/src/libmdsclient/inbound.c
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-09-05 02:16:24 +0200
committerMattias Andrée <maandree@operamail.com>2015-09-05 02:16:24 +0200
commit9c255313e62699427b51fbc43b1b0ac6349363c0 (patch)
tree33bfc5dde450cab3d0185deb0d218e42deb9b56d /src/libmdsclient/inbound.c
parentinfo: libmds_message and libmds_mspool functions (diff)
downloadmds-9c255313e62699427b51fbc43b1b0ac6349363c0.tar.gz
mds-9c255313e62699427b51fbc43b1b0ac6349363c0.tar.bz2
mds-9c255313e62699427b51fbc43b1b0ac6349363c0.tar.xz
doc libmds_mpool
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--src/libmdsclient/inbound.c3
1 files changed, 3 insertions, 0 deletions
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)
{