1<html>
2<head><title>smfi_stop</title></head>
3<body>
4<!--
5$Id: smfi_stop.html,v 1.3 2005/10/27 06:08:57 ca Exp $
6-->
7<h1>smfi_stop</h1>
8
9<table border="0" cellspacing=4 cellpadding=4>
10<!---------- Synopsis ----------->
11<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12<pre>
13#include &lt;libmilter/mfapi.h&gt;
14int smfi_stop(void);
15</pre>
16Shutdown the milter.
17No connections will be accepted after this call.
18</td></tr>
19
20<!----------- Description ---------->
21<tr><th valign="top" align=left>DESCRIPTION</th><td>
22<table border="1" cellspacing=1 cellpadding=4>
23<tr align="left" valign=top>
24<th width="80">Called When</th>
25<td>Called from any of the <a href="api.html#callbacks">Callback</a> routines
26or any error-handling routines at any time.</td>
27</tr>
28<tr align="left" valign=top>
29<th width="80">Effects</th>
30<td>The smfi_stop routine prevents that new connections
31will be accepted,
32however, it does not wait for existing connections (threads) to terminate.
33It will cause
34<a href="smfi_main.html">smfi_main</a> to return to the calling program,
35which may then exit or warm-restart.
36</td>
37</tr>
38</table>
39
40<!----------- Arguments ---------->
41<tr><th valign="top" align=left>ARGUMENTS</th><td>
42    <table border="1" cellspacing=0>
43    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
44    <tr valign="top"><td>void</td>
45	<td>Takes no arguement.
46	</td></tr>
47    </table>
48</td></tr>
49
50<!----------- Return values ---------->
51<tr>
52<th valign="top" align=left>RETURN VALUES</th>
53
54<td>smfi_stop always returns SMFI_CONTINUE. But note:
55<ul>
56    <li>Another internal routine may already have asked the milter to abort.
57    <li>Another routine may already have asked the milter to stop.
58    <li>There is no way to cancel the stop process once it has begun.
59</ul>
60</td>
61</tr>
62
63</table>
64
65<hr size="1">
66<font size="-1">
67Copyright (c) 2003, 2005 Sendmail, Inc. and its suppliers.
68All rights reserved.
69<br>
70By using this file, you agree to the terms and conditions set
71forth in the LICENSE.
72</font>
73</body>
74</html>
75