summaryrefslogtreecommitdiff
path: root/doc/s6-fdholder-delete.html
blob: a0fa6dd95b7b70057e03230d9656d2c86b7bf653 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>s6: the s6-fdholder-delete program</title>
    <meta name="Description" content="s6: the s6-fdholder-delete program" />
    <meta name="Keywords" content="s6 s6-fdholder fd-holding fd-holder fd delete deletion unix socket activation" />
    <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6</a><br />
<a href="http://skarnet.org/software/">Software</a><br />
<a href="http://skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>s6-fdholder-delete</tt> program </h1>

<p>
<tt>s6-fdholder-delete</tt> connects to a
<a href="s6-fdholderd.html">fd-holding daemon</a> listening on a
Unix domain socket, and deletes a file descriptor from the
daemon storage.
</p>

<h2> Interface </h2>

<pre>
     s6-fdholder-delete [ -t <em>timeout</em> ] <em>path</em> <em>id</em>
</pre>

<ul>
 <li> s6-fdholder-delete executes into <tt><a href="s6-ipcclient.html">s6-ipcclient</a> <em>path</em>
<a href="s6-fdholder-deletec.html">s6-fdholder-deletec</a> <em>id</em> </tt>.
It does nothing else: it is just a convenience program.
The <a href="s6-ipcclient.html">s6-ipcclient</a> program connects
to a Unix socket at <em>path</em>, and the
<a href="s6-fdholder-deletec.html">s6-fdholder-deletec</a> program
sends instruction to the server. </li>
 <li> It should be used to connect to a
<a href="s6-fdholderd.html">s6-fdholderd</a> daemon, which will receive
the instruction to close and remove the file descriptor identified
by <em>id</em>. </li>
 <li> It then exits 0. </li>
</ul>

<h2> Options </h2>

<ul>
 <li> <tt>-t&nbsp;<em>timeout</em></tt>&nbsp;: if the operation cannot be
processed in <em>timeout</em> milliseconds, then fail with an error message.
Communications with the server should be near-instant, so this option is
only here to protect users against programming errors (connecting to the
wrong socket, for instance). </li>
</ul>

<h2> Usage example </h2>

<pre>
   s6-fdholder-delete /service/fdholderd/s MYSOCKET
</pre>

<p>
 will tell a
s6-fdholderd daemon listening on the <tt>/service/fdholderd/s</tt>
socket to close the filedescriptor identified as MYSOCKET.
</p>

</body>
</html>