blob: 76adcc2bf63b8fcf73d873d6ecd5f528312c1b8d (
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
72
73
74
|
<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-ftrig-listen program</title>
<meta name="Description" content="s6: the s6-ftrig-listen program" />
<meta name="Keywords" content="s6 command s6-ftrig-listen fifodir notification event listener subscriber receive" />
<!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
</head>
<body>
<p>
<a href="index.html">s6</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>
<h1> The s6-ftrig-listen program </h1>
<p>
s6-ftrig-listen subscribes to several <a href="fifodir.html">fifodirs</a>, then
spawns a program, then waits for pattern of events to occur on the fifodirs.
</p>
<h2> Interface </h2>
<p>
In an <a href="//skarnet.org/software/execline/execlineb.html">execlineb</a>
script:
</p>
<pre>
s6-ftrig-listen [ -a | -o ] [ -t <em>timeout</em> ] { <em>fifodir1</em> <em>regexp1</em> <em>fifodir2</em> <em>regexp2</em> ... } <em>prog...</em>
</pre>
<ul>
<li> s6-ftrig-listen subscribes to <em>fifodir1</em> with the regexp <em>regexp1</em>,
to <em>fifodir2</em> with the regexp <em>regexp2</em>, and so on. </li>
<li> It then forks and exec <em>prog...</em> with all its arguments </li>
<li> It waits for the series of events received on <em>fifodir-i</em>
to match <em>regexp-i</em>, The <em>regexp-i</em> must be
<a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_04">Extended
Regular Expressions</a>. </li>
<li> When the series of read events matches the <em>regexp</em>s,
s6-ftrig-listen exits 0. </li>
</ul>
<h2> Options </h2>
<ul>
<li> <tt>-t <em>timeout</em></tt> : if the events on the <em>fifodir</em>s have not
matched the <em>regexp</em>s after <em>timeout</em> milliseconds, print an error message on
stderr and exit 1. By default, s6-ftrig-listen waits indefinitely for a matching series
of events. </li>
<li> <tt>-a</tt> : and (conjunction). s6-ftrig-listen will only exit when <em>all</em>
the <em>fifodir-i</em> have been notified with events matching the corresponding <em>regexp-i</em>.
This is the default. </li>
<li> <tt>-o</tt> : one (disjunction). s6-ftrig-listen will exit as soon as <em>one</em>
of the <em>fifodir-i</em> has been notified with events matching its <em>regexp-i</em>. </li>
</ul>
<h2> Notes </h2>
<p>
s6-ftrig-listen can be used outside of an execlineb script by using the
internal argv syntax, but this syntax is an implementation detail and is
not documented as stable. In a shell
script, use <tt>execlineb -Pc 's6-ftrig-listen ...'</tt> to get the
benefits of the execlineb brace syntax.
</p>
</body>
</html>
|
