diff options
Diffstat (limited to 'doc/libunixonacid')
-rw-r--r-- | doc/libunixonacid/skaclient.html | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/libunixonacid/skaclient.html b/doc/libunixonacid/skaclient.html index 7deb38b..f4b3020 100644 --- a/doc/libunixonacid/skaclient.html +++ b/doc/libunixonacid/skaclient.html @@ -27,6 +27,40 @@ and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library. <h2> General information </h2> <p> + <tt>skaclient</tt> is a client-server initiation protocol framework, allowing a process +(the "client") to either connect to another process (the "server") via a Unix domain socket, +or spawn such a "server" process itself. The client and the server then communicate +via <em>two</em> sockets, one for synchronous data, the other for asynchronous +data; they exchange <a href="unixmessage.html">unixmessages</a>. +</p> + +<p> + The <tt>skaclient</tt> framework is used in several places in skarnet.org software, +whenever a server can send asynchronous data to its client. For instance: +</p> + +<ul> + <li> Communication between notification subscribers such as +<a href="http://skarnet.org/software/s6/s6-ftrig-wait.html">s6-ftrig-wait</a> +and their own <a href="http://skarnet.org/software/s6/s6-ftrigrd.html">s6-ftrigrd</a> +daemon </li> + <li> Communication between clients of the +<a href="http://skarnet.org/software/s6/libs6lock/">s6lock library</a> and a +<a href="http://skarnet.org/software/s6/libs6lock/s6lockd.html">s6lockd +server</a> </li> + <li> Communication between a client such as +<a href="http://skarnet.org/software/s6-dns/s6-dnsip4-filter.html">s6-dnsip4-filter</a>, +in need of asynchronous DNS service, and its own +<a href="http://skarnet.org/software/s6-dns/skadns/skadnsd.html">skadnsd</a> +daemon </li> + <li> The <a href="http://skarnet.org/software/skabus/">skabus</a> Unix bus +infrastructure is entirely based on the skaclient framework to transmit +unixmessages across processes. </li> +</ul> + +<h2> Programming </h2> + +<p> FIXME: to be completed. </p> |