xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_stop.html (revision e92d3f3ffe83a6ed7eaafac70da9cf4fafe13243)
1e92d3f3fSGregory Neil Shapiro<html>
2e92d3f3fSGregory Neil Shapiro<head><title>smfi_stop</title></head>
3e92d3f3fSGregory Neil Shapiro<body>
4e92d3f3fSGregory Neil Shapiro<!--
5e92d3f3fSGregory Neil Shapiro$Id: smfi_stop.html,v 1.2 2003/11/24 23:38:26 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7e92d3f3fSGregory Neil Shapiro<h1>smfi_stop</h1>
8e92d3f3fSGregory Neil Shapiro
9e92d3f3fSGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
10e92d3f3fSGregory Neil Shapiro<!---------- Synopsis ----------->
11e92d3f3fSGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12e92d3f3fSGregory Neil Shapiro<pre>
13e92d3f3fSGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
14e92d3f3fSGregory Neil Shapiroint smfi_stop(void);
15e92d3f3fSGregory Neil Shapiro</pre>
16e92d3f3fSGregory Neil ShapiroStart an orderly shutdown of the milter. No connections will be accepted
17e92d3f3fSGregory Neil Shapiroafter this call.
18e92d3f3fSGregory Neil Shapiro</td></tr>
19e92d3f3fSGregory Neil Shapiro
20e92d3f3fSGregory Neil Shapiro<!----------- Description ---------->
21e92d3f3fSGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
22e92d3f3fSGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
23e92d3f3fSGregory Neil Shapiro<tr align="left" valign=top>
24e92d3f3fSGregory Neil Shapiro<th width="80">Called When</th>
25e92d3f3fSGregory Neil Shapiro<td>Called from any of the <a href="api.html#callbacks">Callback</a> routines
26e92d3f3fSGregory Neil Shapiroor any error-handling routines at any time.</td>
27e92d3f3fSGregory Neil Shapiro</tr>
28e92d3f3fSGregory Neil Shapiro<tr align="left" valign=top>
29e92d3f3fSGregory Neil Shapiro<th width="80">Effects</th>
30e92d3f3fSGregory Neil Shapiro<td>The smfi_stop routine
31e92d3f3fSGregory Neil Shapirocauses each thread to finish its current connection, then exit.
32e92d3f3fSGregory Neil ShapiroWhen all threads have exited, the call
33e92d3f3fSGregory Neil Shapiroto <a href="smfi_main.html">smfi_main</a> returns to your calling program,
34e92d3f3fSGregory Neil Shapirowhich may then exit or warm-restart.
35e92d3f3fSGregory Neil Shapiro</td>
36e92d3f3fSGregory Neil Shapiro</tr>
37e92d3f3fSGregory Neil Shapiro</table>
38e92d3f3fSGregory Neil Shapiro
39e92d3f3fSGregory Neil Shapiro<!----------- Arguments ---------->
40e92d3f3fSGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
41e92d3f3fSGregory Neil Shapiro    <table border="1" cellspacing=0>
42e92d3f3fSGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
43e92d3f3fSGregory Neil Shapiro    <tr valign="top"><td>void</td>
44e92d3f3fSGregory Neil Shapiro	<td>Takes no arguement.
45e92d3f3fSGregory Neil Shapiro	</td></tr>
46e92d3f3fSGregory Neil Shapiro    </table>
47e92d3f3fSGregory Neil Shapiro</td></tr>
48e92d3f3fSGregory Neil Shapiro
49e92d3f3fSGregory Neil Shapiro<!----------- Return values ---------->
50e92d3f3fSGregory Neil Shapiro<tr>
51e92d3f3fSGregory Neil Shapiro<th valign="top" align=left>RETURN VALUES</th>
52e92d3f3fSGregory Neil Shapiro
53e92d3f3fSGregory Neil Shapiro<td>smfi_stop always returns SMFI_CONTINUE. But note:
54e92d3f3fSGregory Neil Shapiro<ul>
55e92d3f3fSGregory Neil Shapiro    <li>Another internal routine may already have asked the milter to abort.
56e92d3f3fSGregory Neil Shapiro    <li>Another routine may already have asked the milter to stop.
57e92d3f3fSGregory Neil Shapiro    <li>There is no way to cancel the stop process once it has begun.
58e92d3f3fSGregory Neil Shapiro</ul>
59e92d3f3fSGregory Neil Shapiro</td>
60e92d3f3fSGregory Neil Shapiro</tr>
61e92d3f3fSGregory Neil Shapiro
62e92d3f3fSGregory Neil Shapiro</table>
63e92d3f3fSGregory Neil Shapiro
64e92d3f3fSGregory Neil Shapiro<hr size="1">
65e92d3f3fSGregory Neil Shapiro<font size="-1">
66e92d3f3fSGregory Neil ShapiroCopyright (c) 2003 Sendmail, Inc. and its suppliers.
67e92d3f3fSGregory Neil ShapiroAll rights reserved.
68e92d3f3fSGregory Neil Shapiro<br>
69e92d3f3fSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
70e92d3f3fSGregory Neil Shapiroforth in the LICENSE.
71e92d3f3fSGregory Neil Shapiro</font>
72e92d3f3fSGregory Neil Shapiro</body>
73e92d3f3fSGregory Neil Shapiro</html>
74