xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_stop.html (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1<HTML>
2<HEAD><TITLE>smfi_stop</TITLE></HEAD>
3<BODY>
4<!--
5$Id: smfi_stop.html,v 1.8 2013-11-22 20:51:39 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=100>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</TD></TR>
40
41<!----------- Arguments ---------->
42<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
43    <TABLE border="1" cellspacing=0>
44    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
45    <TR valign="top"><TD>void</TD>
46	<TD>Takes no argument.
47	</TD></TR>
48    </TABLE>
49</TD></TR>
50
51<!----------- Return values ---------->
52<TR>
53<TH valign="top" align=left>RETURN VALUES</TH>
54
55<TD>smfi_stop always returns SMFI_CONTINUE. But note:
56<UL>
57    <LI>Another internal routine may already have asked the milter to abort.
58    <LI>Another routine may already have asked the milter to stop.
59    <LI>There is no way to cancel the stop process once it has begun.
60</UL>
61</TD>
62</TR>
63
64</TABLE>
65
66<HR size="1">
67<FONT size="-1">
68Copyright (c) 2003, 2005 Proofpoint, Inc. and its suppliers.
69All rights reserved.
70<BR>
71By using this file, you agree to the terms and conditions set
72forth in the LICENSE.
73</FONT>
74</BODY>
75</HTML>
76