aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-07-15 08:25:54 +0200
committerMattias Andrée <maandree@kth.se>2016-07-15 08:26:00 +0200
commite2cacd65957ee63fb8fd6576cc392015eb4a411d (patch)
tree4b2a642585b8ebf8296c463cd026cd666381c3f6
parentm (diff)
downloadlibcoopgamma-e2cacd65957ee63fb8fd6576cc392015eb4a411d.tar.gz
libcoopgamma-e2cacd65957ee63fb8fd6576cc392015eb4a411d.tar.bz2
libcoopgamma-e2cacd65957ee63fb8fd6576cc392015eb4a411d.tar.xz
Inform the user that SIGCHLD must not be ignored or blocked for some function
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--src/libcoopgamma.c12
-rw-r--r--src/libcoopgamma.h10
2 files changed, 22 insertions, 0 deletions
diff --git a/src/libcoopgamma.c b/src/libcoopgamma.c
index bbc0432..b7debc9 100644
--- a/src/libcoopgamma.c
+++ b/src/libcoopgamma.c
@@ -832,6 +832,8 @@ int libcoopgamma_context_unmarshal(libcoopgamma_context_t* restrict this,
/**
* List all recognised adjustment method
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @return A `NULL`-terminated list of names. You should only free
* the outer pointer, inner pointers are subpointers of the
* outer pointer and cannot be freed. `NULL` on error.
@@ -898,6 +900,8 @@ char** libcoopgamma_get_methods(void)
/**
* Run coopgammad with -q or -qq and return the response
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @param arg "-q" or "-qq", which shall be passed to coopgammad?
@@ -1008,6 +1012,8 @@ static char* libcoopgamma_query(const char* restrict method, const char* restric
/**
* Get the adjustment method and site
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @param methodp Output pointer for the selected adjustment method,
@@ -1080,6 +1086,8 @@ int libcoopgamma_get_method_and_site(const char* restrict method, const char* re
/**
* Get the PID file of the coopgamma server
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @return The pathname of the server's PID file, `NULL` on error
@@ -1111,6 +1119,8 @@ char* libcoopgamma_get_pid_file(const char* restrict method, const char* restric
/**
* Get the socket file of the coopgamma server
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @return The pathname of the server's socket, `NULL` on error
@@ -1157,6 +1167,8 @@ char* libcoopgamma_get_socket_file(const char* restrict method, const char* rest
*
* Use `libcoopgamma_context_destroy` to disconnect
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @param ctx The state of the library, must be initialised
diff --git a/src/libcoopgamma.h b/src/libcoopgamma.h
index d552799..9c33646 100644
--- a/src/libcoopgamma.h
+++ b/src/libcoopgamma.h
@@ -1014,6 +1014,8 @@ int libcoopgamma_context_unmarshal(libcoopgamma_context_t* restrict, const void*
/**
* List all recognised adjustment method
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @return A `NULL`-terminated list of names. You should only free
* the outer pointer, inner pointers are subpointers of the
* outer pointer and cannot be freed. `NULL` on error.
@@ -1023,6 +1025,8 @@ char** libcoopgamma_get_methods(void);
/**
* Get the adjustment method and site
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @param methodp Output pointer for the selected adjustment method,
@@ -1041,6 +1045,8 @@ int libcoopgamma_get_method_and_site(const char* restrict, const char* restrict,
/**
* Get the PID file of the coopgamma server
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @return The pathname of the server's PID file, `NULL` on error
@@ -1052,6 +1058,8 @@ char* libcoopgamma_get_pid_file(const char* restrict, const char* restrict);
/**
* Get the socket file of the coopgamma server
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @return The pathname of the server's socket, `NULL` on error
@@ -1068,6 +1076,8 @@ char* libcoopgamma_get_socket_file(const char* restrict, const char* restrict);
*
* Use `libcoopgamma_context_destroy` to disconnect
*
+ * SIGCHLD must not be ignored or blocked
+ *
* @param method The adjustment method, `NULL` for automatic
* @param site The site, `NULL` for automatic
* @param ctx The state of the library, must be initialised