From bf4020471356938b9181a33984f511ffdd7ff25b Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 22 Oct 2019 18:59:27 +0200
Subject: Change license, change style, clean up, flat file hier, clean
 valgrind output in test
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 libcoopgamma_get_socket_file.3 | 86 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 libcoopgamma_get_socket_file.3

(limited to 'libcoopgamma_get_socket_file.3')

diff --git a/libcoopgamma_get_socket_file.3 b/libcoopgamma_get_socket_file.3
new file mode 100644
index 0000000..f73f0ca
--- /dev/null
+++ b/libcoopgamma_get_socket_file.3
@@ -0,0 +1,86 @@
+.TH LIBCOOPGAMMA_GET_SOCKET_FILE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_get_socket_file - Get the socket file of the coopgamma server
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+char *libcoopgamma_get_socket_file(const char *restrict \fImethod\fP, const char *restrict \fIsite\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+Newcomers need not concern themselves with the
+.BR libcoopgamma_get_socket_file ()
+function.
+.P
+The
+.BR libcoopgamma_get_socket_file ()
+function consults
+.BR coopgammad (1)
+to get the pathname of the socket for
+communicating with the
+.BR coopgammad (1)
+instance for the selected adjustment
+.I method
+and
+.IR site .
+If
+.I method
+or
+.I site
+is
+.IR NULL ,
+the it will selected automatically.
+.P
+For the duration of the function call,
+.I SIGCHLD
+most neither be ignored nor blocked. It is the
+user of this library's responsibility to ensure
+this. The
+.BR libcoopgamma_get_socket_file ()
+function will not temporarily reset handling of
+.I SIGCHLD
+itself.
+.SH "RETURN VALUES"
+Upon successful completion, the
+.BR libcoopgamma_get_socket_file ()
+function returns the pathname of the socket.
+Success does not mean that the server is necessarily
+running at the moment. The user should free
+the returned pointer. On error,
+.I NULL
+is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+The
+.BR libcoopgamma_get_socket_file ()
+function may fail for any reason specified for
+.BR pipe (3),
+.BR fork (3),
+.BR dup2 (3),
+.BR execvp (3),
+.BR malloc (3),
+.BR realloc (3),
+.BR read (3)
+(other than
+.IR EINTR ),
+and
+.BR waitpid (3).
+The function may also fail for any of the
+following reasons:
+.TP
+.B EINVAL
+If
+.I method
+contain an invalid adjustment method name.
+.TP
+.B EBADMSG
+.BR coopgammad (1)
+output invalid data to stdout.
+.SH "SEE ALSO"
+.BR libcoopgamma_get_methods (3),
+.BR libcoopgamma_get_pid_file (3),
+.BR libcoopgamma_context_initialise (3)
-- 
cgit v1.2.3-70-g09d2