summaryrefslogtreecommitdiff
path: root/doc/libunixonacid
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2014-09-18 18:55:44 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2014-09-18 18:55:44 +0000
commit3534b428629be185e096be99e3bd5fdfe32d5544 (patch)
tree210ef3198ed66bc7f7b7bf6a85e4579f455e5a36 /doc/libunixonacid
downloadskalibs-3534b428629be185e096be99e3bd5fdfe32d5544.tar.xz
initial commit with rc for skalibs-2.0.0.0
Diffstat (limited to 'doc/libunixonacid')
-rw-r--r--doc/libunixonacid/index.html58
-rw-r--r--doc/libunixonacid/kolbak.html40
-rw-r--r--doc/libunixonacid/skaclient.html34
-rw-r--r--doc/libunixonacid/unix-timed.html34
-rw-r--r--doc/libunixonacid/unix-transactional.html34
-rw-r--r--doc/libunixonacid/unixmessage.html40
6 files changed, 240 insertions, 0 deletions
diff --git a/doc/libunixonacid/index.html b/doc/libunixonacid/index.html
new file mode 100644
index 0000000..81b024f
--- /dev/null
+++ b/doc/libunixonacid/index.html
@@ -0,0 +1,58 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>skalibs: the unixonacid library interface</title
+ <meta name="Description" content="skalibs: the unixonacid library interface" />
+ <meta name="Keywords" content="skalibs library unixonacid libunixonacid unixonacid.h" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="../libskarnet.html">libskarnet</a><br />
+<a href="../index.html">skalibs</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>unixonacid</tt> library interface </h1>
+
+<p>
+<tt>libunixonacid</tt> provides higher-level interfaces to Unix
+concepts such as the filesystem - for instance, it provides a way to
+access several files atomically, be it for reading or for writing - or
+interprocess communication.
+</p>
+
+
+<h2> Compiling </h2>
+
+<ul>
+ <li> Use <tt>#include &lt;skalibs/unixonacid.h&gt;</tt> </li>
+</ul>
+
+<h2> Programming </h2>
+
+<p>
+ The <tt>skalibs/unixonacid.h</tt> header is actually a concatenation of other
+headers, every one of each declaring related structures, macros and
+functions.
+</p>
+
+<ul>
+ <li> <a href="unix-transactional.html">skalibs/unix-transactional.h</a>:
+transactional filesystem operations </li>
+ <li> <a href="unix-timed.html">skalibs/unix-timed.h</a>: timed synchronous
+IPC or network operations </li>
+ <li> <a href="unixmessage.html">skalibs/unixmessage.h</a>: safe
+asynchronous and synchronous message
+transmission between processes via Unix sockets, including fd-passing </li>
+ <li> <a href="kolbak.html">skalibs/kolbak.h</a>: simple callback management
+for asynchronous message transmission </li>
+ <li> <a href="skaclient.html">skalibs/skaclient.h</a>: higher-level
+client-server interface using messages </li>
+</ul>
+
+</body>
+</html>
diff --git a/doc/libunixonacid/kolbak.html b/doc/libunixonacid/kolbak.html
new file mode 100644
index 0000000..a7480e8
--- /dev/null
+++ b/doc/libunixonacid/kolbak.html
@@ -0,0 +1,40 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>skalibs: the kolbak library interface</title>
+ <meta name="Description" content="skalibs: the kolbak library interface" />
+ <meta name="Keywords" content="skalibs c kolbak library libunixonacid" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">libunixonacid</a><br />
+<a href="../libskarnet.html">libskarnet</a><br />
+<a href="../index.html">skalibs</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>kolbak</tt> library interface </h1>
+
+<p>
+ The following functions are declared in the <tt>skalibs/kolbak.h</tt> header,
+and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library.
+</p>
+
+<h2> General information </h2>
+
+<p>
+ <tt>kolbak</tt> implements simple queuing of callback functions to use when
+sending a message to a peer and expecting an answer, which will be handled
+by the callback function. The queue is a circular buffer.
+</p>
+
+<p>
+ FIXME: To be completed.
+</p>
+
+</body>
+</html>
diff --git a/doc/libunixonacid/skaclient.html b/doc/libunixonacid/skaclient.html
new file mode 100644
index 0000000..7deb38b
--- /dev/null
+++ b/doc/libunixonacid/skaclient.html
@@ -0,0 +1,34 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>skalibs: the skaclient library interface</title>
+ <meta name="Description" content="skalibs: the skaclient library interface" />
+ <meta name="Keywords" content="skalibs c skaclient library libunixonacid" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">libunixonacid</a><br />
+<a href="../libskarnet.html">libskarnet</a><br />
+<a href="../index.html">skalibs</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>skaclient</tt> library interface </h1>
+
+<p>
+ The following functions are declared in the <tt>skalibs/skaclient.h</tt> header,
+and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library.
+</p>
+
+<h2> General information </h2>
+
+<p>
+FIXME: to be completed.
+</p>
+
+</body>
+</html>
diff --git a/doc/libunixonacid/unix-timed.html b/doc/libunixonacid/unix-timed.html
new file mode 100644
index 0000000..5261475
--- /dev/null
+++ b/doc/libunixonacid/unix-timed.html
@@ -0,0 +1,34 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>skalibs: the unix-timed library interface</title>
+ <meta name="Description" content="skalibs: the unix-timed library interface" />
+ <meta name="Keywords" content="skalibs c unix-timed library libunixonacid" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">libunixonacid</a><br />
+<a href="../libskarnet.html">libskarnet</a><br />
+<a href="../index.html">skalibs</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>unix-timed</tt> library interface </h1>
+
+<p>
+ The following functions are declared in the <tt>skalibs/unix-timed.h</tt> header,
+and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library.
+</p>
+
+<h2> General information </h2>
+
+<p>
+FIXME: to be completed.
+</p>
+
+</body>
+</html>
diff --git a/doc/libunixonacid/unix-transactional.html b/doc/libunixonacid/unix-transactional.html
new file mode 100644
index 0000000..036d8cd
--- /dev/null
+++ b/doc/libunixonacid/unix-transactional.html
@@ -0,0 +1,34 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>skalibs: the unix-transactional library interface</title>
+ <meta name="Description" content="skalibs: the unix-transactional library interface" />
+ <meta name="Keywords" content="skalibs c unix-transactional library libunixonacid" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">libunixonacid</a><br />
+<a href="../libskarnet.html">libskarnet</a><br />
+<a href="../index.html">skalibs</a><br />
+<a href="http://www.skarnet.org/software/">Software</a><br />
+<a href="http://www.skarnet.org/">www.skarnet.org</a>
+</p>
+
+<h1> The <tt>unix-transactional</tt> library interface </h1>
+
+<p>
+ The following functions are declared in the <tt>skalibs/unix-transactional.h</tt> header,
+and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library.
+</p>
+
+<h2> General information </h2>
+
+<p>
+FIXME: to be completed.
+</p>
+
+</body>
+</html>
diff --git a/doc/libunixonacid/unixmessage.html b/doc/libunixonacid/unixmessage.html
new file mode 100644
index 0000000..2a6c46d
--- /dev/null
+++ b/doc/libunixonacid/unixmessage.html
@@ -0,0 +1,40 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>skalibs: the unixmessage library interface</title>
+ <meta name="Description" content="skalibs: the unixmessage library interface" />
+ <meta name="Keywords" content="skalibs c unixmessage library libunixonacid" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">libunixonacid</a><br />
+<a href="../libskarnet.html">libskarnet</a><br />
+<a href="../index.html">skalibs</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>unixmessage</tt> library interface </h1>
+
+<p>
+ The following functions are declared in the <tt>skalibs/unixmessage.h</tt> header,
+and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library.
+</p>
+
+<h2> General information </h2>
+
+<p>
+ <tt>unixmessage</tt> implements message transmission over Unix domain sockets.
+Messages are made of standard untyped data (strings), but can also include file
+descriptors using fd-passing.
+</p>
+
+<p>
+ FIXME: To be completed.
+</p>
+
+</body>
+</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-10 14:07:12 +0000