blob: 42110c99e956a8ae263dd96f51ebc7af211147e1 (
plain)
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
|
<html>
<head><title>smfi_stop</title></head>
<body>
<!--
$Sendmail: smfi_stop.html,v 1.2 2003/11/24 23:38:26 ca Exp $
-->
<h1>smfi_stop</h1>
<table border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
<pre>
#include <libmilter/mfapi.h>
int smfi_stop(void);
</pre>
Start an orderly shutdown of the milter. No connections will be accepted
after this call.
</td></tr>
<!----------- Description ---------->
<tr><th valign="top" align=left>DESCRIPTION</th><td>
<table border="1" cellspacing=1 cellpadding=4>
<tr align="left" valign=top>
<th width="80">Called When</th>
<td>Called from any of the <a href="api.html#callbacks">Callback</a> routines
or any error-handling routines at any time.</td>
</tr>
<tr align="left" valign=top>
<th width="80">Effects</th>
<td>The smfi_stop routine
causes each thread to finish its current connection, then exit.
When all threads have exited, the call
to <a href="smfi_main.html">smfi_main</a> returns to your calling program,
which may then exit or warm-restart.
</td>
</tr>
</table>
<!----------- Arguments ---------->
<tr><th valign="top" align=left>ARGUMENTS</th><td>
<table border="1" cellspacing=0>
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
<tr valign="top"><td>void</td>
<td>Takes no arguement.
</td></tr>
</table>
</td></tr>
<!----------- Return values ---------->
<tr>
<th valign="top" align=left>RETURN VALUES</th>
<td>smfi_stop always returns SMFI_CONTINUE. But note:
<ul>
<li>Another internal routine may already have asked the milter to abort.
<li>Another routine may already have asked the milter to stop.
<li>There is no way to cancel the stop process once it has begun.
</ul>
</td>
</tr>
</table>
<hr size="1">
<font size="-1">
Copyright (c) 2003 Sendmail, Inc. and its suppliers.
All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
</font>
</body>
</html>
|
