summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2015-06-30 16:03:57 +0200
committerWerner Koch <wk@gnupg.org>2015-06-30 16:03:57 +0200
commit87def94c86d5272c23daf2b5ea446c5553aa1d90 (patch)
tree9bb02b34259e07857655789304e4c87098e02446 /doc
parentcd8face27cc96cb0092c920e6e5bdee81a61c420 (diff)
downloadlibassuan-87def94c86d5272c23daf2b5ea446c5553aa1d90.tar.gz
Add assuan_sock_set_flag and assuan_sock_get_flag.
* src/assuan-socket.c (_assuan_sock_set_flag): New. (assuan_sock_set_flag): New. (_assuan_sock_get_flag, assuan_sock_get_flag): New. * src/assuan.h.in (assuan_sock_set_flag): New. (assuan_sock_get_flag): New. * src/libassuan.def: Add them. * src/libassuan.vers: Add them. -- These new functions are intended for a Cygwin socket emulation. This commit merely introduces a generic framework. Signed-off-by: Werner Koch <wk@gnupg.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/assuan.texi24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/assuan.texi b/doc/assuan.texi
index 10b309c..1c3c2ca 100644
--- a/doc/assuan.texi
+++ b/doc/assuan.texi
@@ -2046,6 +2046,30 @@ code it may be used on POSIX systems as well, where this function is
a nop.
@end deftypefun
+To control certain properties of the wrapper two additional functions
+are provided:
+
+@deftypefun int assuan_sock_set_flag ( @
+ @w{assuan_fd_t @var{fd}}, @
+ @w{const char *@var{name}}, @
+ @w{int @var{value}})
+
+Set the flags @var{name} for socket @var{fd} to @var{value}. See
+below for a list of valid names. Returns 0 on success; on failure
+sets ERRNO and returns -1.
+@end deftypefun
+
+@deftypefun int assuan_sock_get_flag ( @
+ @w{assuan_fd_t @var{fd}}, @
+ @w{const char *@var{name}}, @
+ @w{int *@var{r_value}})
+
+Store the current value of the flag @var{name} for socket @var{fd} at
+@var{r_value}. See below for a list of valid names. Returns 0 on
+success; on failure sets ERRNO and returns -1.
+@end deftypefun
+
+No flags are defined.
@c ---------------------------------------------------------------------