<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>The 66 Suite: 66-stop</title>
<meta name="Description" content="Detailed documentation for the 66-stop command which is part of the 66 software suite" />
<meta name="Keywords" content="66 command 66-stop service supervision supervise stop service" />
<!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
</head>
<body>
<p>
<a href="index.html">66</a><br />
<a href="//obarun.org/">www.obarun.org</a>
</p>
<h1>66-stop</h1>
<p>
This command stops one ore more <em>services</em> defined in <em>tree</em>.
</p>
<h2> Interface </h2>
<pre>
66-stop [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u ] [ -X ] [ -K ] <em>service(s)</em>
</pre>
<p>
The <em>service</em> to be stopped is expected to be enabled inside the given <em>tree</em> and started inside an already running <em>scandir</em>.
If the state of the <em>service</em> is already down <tt>66-stop</tt> does nothing.
Generally speaking this command is the strict opposite of <tt><a href="66-start.html">66-start</a></tt>.</p>
<p>Multiple <em>services</em> can be stopped by seperating their names with a space.</p>
<h2> Options </h2>
<ul>
<li> <tt>-h </tt> : prints this help. </li>
<li>
<tt>-v <em>verbosity</em> </tt> : increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print
error messages. <tt>2</tt>: Also print warning messages.
<tt>3</tt>: Also print debugging messages.
</li>
<li>
<tt>-l <em>live</em> </tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
also be changed at compile time by passing the <tt>--livedir=<em>live</em></tt>
option to <tt>./configure</tt>. An existing absolute path is expected and
should be within a writable filesystem - likely a RAM filesystem—see <tt><a href="66-scandir.html">66-scandir</a></tt>.
</li>
<li>
<tt>-t <em>tree</em> </tt> : stops <em>service</em> in
the given <em>tree</em>. This option is mandatory
except if a tree was marked as 'current'—see <a href="66-tree.html"><tt>66-tree</tt></a>.
</li>
<li>
<tt>-T <em>timeout</em> </tt></tt> : specifies a timeout (in milliseconds)
after which <tt>66-stop</tt> will exit 111 with an error message if the service still hasn't reached the up state;
defaults to 1000.
</li>
<li>
<tt>-u </tt> : unsupervise the <em>service</em>.
Remove the <em>service</em> directory from the <em>scandir</em> at the end of the stop process. This option only applies to services of type <tt><em>'classic'</em></tt>.
</li>
<li>
<tt>-X </tt> : exit. The supervisor of the service will exit too. This command should normally never be used on a working system.
</li>
<li>
<tt>-K </tt> : sends a SIGKILL to the <em>service</em> and keep it down.
</li>
</ul>
<h2 id="dependencies">Dependency handling</h2>
<p>For <em>services</em> of type <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt> any existing dependency chain will be resolved automatically.
It is unnecessary to manually define chained sets of dependencies. If FooA has a declared dependency on another service with the name FooB then FooB will be automatically considered and stopped first when stopping FooA.
This works recursively until all dependencies are stopped.</p>
<h2>Classic service transitions</h2>
<p>
<ul>
<li>
<tt>66-stop</tt> gathers the classic service(s) passed as argument in a list called <em>selection</em>.
</li>
<li>
The <em>selection</em> is then inspected and searched for any logger that may be associated with the passed <em>service(s)</em>.
If any such instruction was found the corresponding logger will be added to the <em>selection</em> as well.
</li>
<li>
The command continues issueing <tt>66-svctl -v <em>verbosity</em> -T <em>timeout</em> -l <em>live</em> -t <em>tree</em> -D <em>selection</em></tt>
and waits for the resulting exit code.
</li>
<li>
Finally the <em>service</em> directory is removed from the <em>scandir</em>.
</li>
</ul>
</p>
<p>If any one of these processes fails then as a result <tt>66-stop</tt> fails too and exits with code 111.</p>
<h2>Bundle, longrun, oneshot transitions</h2>
<p>The process for these service types is very similar to that of classic services except for the automated command that adapts accordingly.
<ul>
<li>
<tt>66-stop</tt> gathers the bundle, longrun and/or oneshot service(s) passed as argument in a list called <em>selection</em>.
</li>
<li>
The <em>selection</em> is then inspected and searched for any logger that may be associated with the passed <em>service(s)</em>.
If any such instruction was found the corresponding logger will be added to the <em>selection</em> as well.
</li>
<li>
Finally the command issues <tt>66-dbctl -v <em>verbosity</em> -T <em>timeout</em> -l <em>live</em> -t <em>tree</em> -d <em>selection</em></tt>
and waits for the resulting exit code.
</li>
</ul>
</p>
<p>If any one of these processes fails then as a result <tt>66-stop</tt> fails too and exits with code 111.</p>
</body>
</html>