aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-07-15 17:14:55 +0200
committerMattias Andrée <maandree@kth.se>2016-07-15 17:14:55 +0200
commite837385f1ae7103eff0f2b7d2a4ff22e2979900a (patch)
treec973ac927ea121c0c85b2224c2513911a93869df
parentAdd libcoopgamma_set_nonblocking and prototype for libcoopgamma_synchronise (diff)
downloadlibcoopgamma-e837385f1ae7103eff0f2b7d2a4ff22e2979900a.tar.gz
libcoopgamma-e837385f1ae7103eff0f2b7d2a4ff22e2979900a.tar.bz2
libcoopgamma-e837385f1ae7103eff0f2b7d2a4ff22e2979900a.tar.xz
m doc
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--src/libcoopgamma.c7
-rw-r--r--src/libcoopgamma.h7
2 files changed, 14 insertions, 0 deletions
diff --git a/src/libcoopgamma.c b/src/libcoopgamma.c
index b26c7b8..36ffde2 100644
--- a/src/libcoopgamma.c
+++ b/src/libcoopgamma.c
@@ -1279,6 +1279,13 @@ int libcoopgamma_connect(const char* restrict method, const char* restrict site,
* By default communication is blocking, this function
* can be used to switch between blocking and nonblocking
*
+ * After setting the communication to nonblocking,
+ * `libcoopgamma_flush`, `libcoopgamma_synchronise` and
+ * and request-sending functions can fail with EAGAIN and
+ * EWOULDBLOCK. It is safe to continue with `libcoopgamma_flush`
+ * (for `libcoopgamma_flush` it selfand equest-sending functions)
+ * or `libcoopgamma_synchronise` just like EINTR failure.
+ *
* @param ctx The state of the library, must be connected
* @param nonblocking Nonblocking mode?
* @return Zero on success, -1 on error
diff --git a/src/libcoopgamma.h b/src/libcoopgamma.h
index cef8fc1..4ed1fad 100644
--- a/src/libcoopgamma.h
+++ b/src/libcoopgamma.h
@@ -1211,6 +1211,13 @@ int libcoopgamma_connect(const char* restrict, const char* restrict, libcoopgamm
* By default communication is blocking, this function
* can be used to switch between blocking and nonblocking
*
+ * After setting the communication to nonblocking,
+ * `libcoopgamma_flush`, `libcoopgamma_synchronise` and
+ * and request-sending functions can fail with EAGAIN and
+ * EWOULDBLOCK. It is safe to continue with `libcoopgamma_flush`
+ * (for `libcoopgamma_flush` it selfand equest-sending functions)
+ * or `libcoopgamma_synchronise` just like EINTR failure.
+ *
* @param ctx The state of the library, must be connected
* @param nonblocking Nonblocking mode?
* @return Zero on success, -1 on error