xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_stop.html (revision 4e4196cb7454f47341efebe4e0a17f1b8cd534c7)
1e92d3f3fSGregory Neil Shapiro<html>
2e92d3f3fSGregory Neil Shapiro<head><title>smfi_stop</title></head>
3e92d3f3fSGregory Neil Shapiro<body>
4e92d3f3fSGregory Neil Shapiro<!--
54e4196cbSGregory Neil Shapiro$Id: smfi_stop.html,v 1.3 2005/10/27 06:08:57 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>
164e4196cbSGregory Neil ShapiroShutdown the milter.
174e4196cbSGregory Neil ShapiroNo connections will be accepted after 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>
304e4196cbSGregory Neil Shapiro<td>The smfi_stop routine prevents that new connections
314e4196cbSGregory Neil Shapirowill be accepted,
324e4196cbSGregory Neil Shapirohowever, it does not wait for existing connections (threads) to terminate.
334e4196cbSGregory Neil ShapiroIt will cause
344e4196cbSGregory Neil Shapiro<a href="smfi_main.html">smfi_main</a> to return to the calling program,
35e92d3f3fSGregory Neil Shapirowhich may then exit or warm-restart.
36e92d3f3fSGregory Neil Shapiro</td>
37e92d3f3fSGregory Neil Shapiro</tr>
38e92d3f3fSGregory Neil Shapiro</table>
39e92d3f3fSGregory Neil Shapiro
40e92d3f3fSGregory Neil Shapiro<!----------- Arguments ---------->
41e92d3f3fSGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
42e92d3f3fSGregory Neil Shapiro    <table border="1" cellspacing=0>
43e92d3f3fSGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
44e92d3f3fSGregory Neil Shapiro    <tr valign="top"><td>void</td>
45e92d3f3fSGregory Neil Shapiro	<td>Takes no arguement.
46e92d3f3fSGregory Neil Shapiro	</td></tr>
47e92d3f3fSGregory Neil Shapiro    </table>
48e92d3f3fSGregory Neil Shapiro</td></tr>
49e92d3f3fSGregory Neil Shapiro
50e92d3f3fSGregory Neil Shapiro<!----------- Return values ---------->
51e92d3f3fSGregory Neil Shapiro<tr>
52e92d3f3fSGregory Neil Shapiro<th valign="top" align=left>RETURN VALUES</th>
53e92d3f3fSGregory Neil Shapiro
54e92d3f3fSGregory Neil Shapiro<td>smfi_stop always returns SMFI_CONTINUE. But note:
55e92d3f3fSGregory Neil Shapiro<ul>
56e92d3f3fSGregory Neil Shapiro    <li>Another internal routine may already have asked the milter to abort.
57e92d3f3fSGregory Neil Shapiro    <li>Another routine may already have asked the milter to stop.
58e92d3f3fSGregory Neil Shapiro    <li>There is no way to cancel the stop process once it has begun.
59e92d3f3fSGregory Neil Shapiro</ul>
60e92d3f3fSGregory Neil Shapiro</td>
61e92d3f3fSGregory Neil Shapiro</tr>
62e92d3f3fSGregory Neil Shapiro
63e92d3f3fSGregory Neil Shapiro</table>
64e92d3f3fSGregory Neil Shapiro
65e92d3f3fSGregory Neil Shapiro<hr size="1">
66e92d3f3fSGregory Neil Shapiro<font size="-1">
674e4196cbSGregory Neil ShapiroCopyright (c) 2003, 2005 Sendmail, Inc. and its suppliers.
68e92d3f3fSGregory Neil ShapiroAll rights reserved.
69e92d3f3fSGregory Neil Shapiro<br>
70e92d3f3fSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
71e92d3f3fSGregory Neil Shapiroforth in the LICENSE.
72e92d3f3fSGregory Neil Shapiro</font>
73e92d3f3fSGregory Neil Shapiro</body>
74e92d3f3fSGregory Neil Shapiro</html>
75