aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-07-20 21:05:47 +0200
committerMattias Andrée <maandree@kth.se>2016-07-20 21:05:47 +0200
commit60ff062e0447b61f03a11e7accef338da3afa881 (patch)
treeed476438d2db0a5c0b6a795b70deee5ac3c3915a /doc
parentm (diff)
downloadlibcoopgamma-60ff062e0447b61f03a11e7accef338da3afa881.tar.gz
libcoopgamma-60ff062e0447b61f03a11e7accef338da3afa881.tar.bz2
libcoopgamma-60ff062e0447b61f03a11e7accef338da3afa881.tar.xz
Add libcoopgamma_set_nonblocking.3
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/libcoopgamma_set_nonblocking.349
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/man/libcoopgamma_set_nonblocking.3 b/doc/man/libcoopgamma_set_nonblocking.3
new file mode 100644
index 0000000..821a0c6
--- /dev/null
+++ b/doc/man/libcoopgamma_set_nonblocking.3
@@ -0,0 +1,49 @@
+.TH LIBCOOPGAMMA_SET_NONBLOCKING 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_set_nonblocking - Switch to or from nonblocking communication
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_set_nonblocking(libcoopgamma_context_t *restrict \fIctx\fP, int \fInonblocking\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_set_nonblocking ()
+function sets the communication with the server for
+the connection of
+.I ctx
+to be nonblocking if
+.I nonblocking
+is nonzero,
+and to be block otherwise.
+.I ctx
+must already be connected to the server,
+which is achieved by calling the
+.BR libcoopgamma_connect (3)
+functon.
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_set_nonblocking ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+The
+.BR libcoopgamma_connect ()
+function may fail for any reason specified for
+.BR fcntl (3)
+with
+.I F_GETFL
+or
+.I F_SETFL
+as the second argument.
+.SH "SEE ALSO"
+.BR libcoopgamma_connect (3),
+.BR libcoopgamma_get_crtcs_send (3),
+.BR libcoopgamma_get_gamma_info_send (3),
+.BR libcoopgamma_get_gamma_send (3),
+.BR libcoopgamma_set_gamma_send (3)