summaryrefslogtreecommitdiff
path: root/doc/libs6
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2017-11-27 12:44:40 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2017-11-27 12:44:40 +0000
commitc3150e36d6e3d8392c5801a19b7f63daa5551f37 (patch)
tree6fa1e3579c275898c964dace54184116d7d256e5 /doc/libs6
parentb40d48d8fe2b7ff838d8e57482cd02f83987b7fd (diff)
downloads6-c3150e36d6e3d8392c5801a19b7f63daa5551f37.tar.xz
Add s6_fdholder_start/end, prepare for 2.6.2.0
Diffstat (limited to 'doc/libs6')
-rw-r--r--doc/libs6/s6-fdholder.html22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/libs6/s6-fdholder.html b/doc/libs6/s6-fdholder.html
index af6df38..0a2413b 100644
--- a/doc/libs6/s6-fdholder.html
+++ b/doc/libs6/s6-fdholder.html
@@ -91,6 +91,28 @@ started by <a href="../s6-ipcclient.html">s6-ipcclient</a>, both fds 6
and 7 are open (and refer to the same socket), so you should close both.
</p>
+<p>
+ Alternatively, if your connection to s6-fdholderd has not been created yet,
+you can use the following functions:
+</p>
+
+<h4> <code> int s6_fdholder_start (s6_fdholder_t *a, char const *path, tain_t const *deadline, tain_t *stamp) </code> </h4>
+
+<p>
+ Starts a session with a <a href="../s6-fdholderd.html">s6-fdholderd</a>
+instance listening on <em>path</em>. <em>a</em> must be initialized to
+S6_FDHOLDER_ZERO before calling this function. On success, returns nonzero
+and <em>a</em> can be used as a handle for the next <tt>s6_fdholder_*</tt>
+function calls. On failure, returns 0, and sets errno.
+</p>
+
+<h4> <code> void s6_fdholder_end (s6_fdholder_t *a) </code> </h4>
+
+<p>
+ Ends the current session and frees all allocated resources. If needed,
+<em>a</em> is immediately reusable for another <tt>s6_fdholder_start</tt> call.
+</p>
+
<h3> Storing a fd </h3>
<pre>