aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/libmdsclient/inbound.c3
-rw-r--r--src/libmdsclient/inbound.h3
2 files changed, 6 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)
{
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);