blob: c7b21f8f575d9f6ffeec3c50219d3cfe7383dea8 (
plain) (
blame)
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 name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Language" content="en" />
<title>s6: the s6-fdholder-setdump program</title>
<meta name="Description" content="s6: the s6-fdholder-setdump program" />
<meta name="Keywords" content="s6 s6-fdholder fd-holding fd-holder fd dump storage 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-setdump</tt> program </h1>
<p>
<tt>s6-fdholder-setdump</tt> connects to a
<a href="s6-fdholderd.html">fd-holding daemon</a> listening on a
Unix domain socket, and dumps a set of file descriptors into
that daemon.
</p>
<h2> Interface </h2>
<pre>
s6-fdholder-setdump [ -t <em>timeout</em> ] <em>path</em>
</pre>
<ul>
<li> s6-fdholder-setdump executes into <tt><a href="s6-ipcclient.html">s6-ipcclient</a> <em>path</em>
<a href="s6-fdholder-setdumpc.html">s6-fdholder-setdumpc</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-setdumpc.html">s6-fdholder-setdumpc</a> program transmits the
file descriptors over the socket. </li>
<li> It should be used to connect to a
<a href="s6-fdholderd.html">s6-fdholderd</a> daemon, which will store the set of
file descriptors. </li>
</ul>
<h2> Options </h2>
<ul>
<li> <tt>-t <em>timeout</em></tt> : 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> Notes </h2>
<ul>
<li> The file descriptors to transmit to the server should of course be
already open in the s6-fdholder-setdump program; also, s6-fdholder-setdump
should have certain environment variables that describe that set of file
descriptors. The format of the environment is the same as the one set by
<a href="s6-fdholder-getdumpc.html">s6-fdholder-getdumpc</a>. </li>
<li> Getting the whole state of a s6-fdholderd daemon requires specific
privileges. Make sure you properly
<a href="s6-fdholderd.html#configuration">configure the s6-fdholderd
access rights</a> so your client can perform that operation. </li>
</ul>
</body>
</html>
|
