xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_stop.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_stop</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: smfi_stop.html,v 1.8 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_stop</H1>
8e92d3f3fSGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
10e92d3f3fSGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
13e92d3f3fSGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
14e92d3f3fSGregory Neil Shapiroint smfi_stop(void);
15d0cef73dSGregory Neil Shapiro</PRE>
164e4196cbSGregory Neil ShapiroShutdown the milter.
174e4196cbSGregory Neil ShapiroNo connections will be accepted after this call.
18d0cef73dSGregory Neil Shapiro</TD></TR>
19e92d3f3fSGregory Neil Shapiro
20e92d3f3fSGregory Neil Shapiro<!----------- Description ---------->
21d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
22d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
23d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
24d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
25d0cef73dSGregory Neil Shapiro<TD>Called from any of the <A href="api.html#Callbacks">Callback</A> routines
26d0cef73dSGregory Neil Shapiroor any error-handling routines at any time.</TD>
27d0cef73dSGregory Neil Shapiro</TR>
28d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
29d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
30d0cef73dSGregory 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
34d0cef73dSGregory 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.
36d0cef73dSGregory Neil Shapiro</TD>
37d0cef73dSGregory Neil Shapiro</TR>
38d0cef73dSGregory Neil Shapiro</TABLE>
39*5b0945b5SGregory Neil Shapiro</TD></TR>
40e92d3f3fSGregory Neil Shapiro
41e92d3f3fSGregory Neil Shapiro<!----------- Arguments ---------->
42d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
43d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
44d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
45d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>void</TD>
466f9c8e5bSGregory Neil Shapiro	<TD>Takes no argument.
47d0cef73dSGregory Neil Shapiro	</TD></TR>
48d0cef73dSGregory Neil Shapiro    </TABLE>
49d0cef73dSGregory Neil Shapiro</TD></TR>
50e92d3f3fSGregory Neil Shapiro
51e92d3f3fSGregory Neil Shapiro<!----------- Return values ---------->
52d0cef73dSGregory Neil Shapiro<TR>
53d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
54e92d3f3fSGregory Neil Shapiro
55d0cef73dSGregory Neil Shapiro<TD>smfi_stop always returns SMFI_CONTINUE. But note:
56d0cef73dSGregory Neil Shapiro<UL>
57d0cef73dSGregory Neil Shapiro    <LI>Another internal routine may already have asked the milter to abort.
58d0cef73dSGregory Neil Shapiro    <LI>Another routine may already have asked the milter to stop.
59d0cef73dSGregory Neil Shapiro    <LI>There is no way to cancel the stop process once it has begun.
60d0cef73dSGregory Neil Shapiro</UL>
61d0cef73dSGregory Neil Shapiro</TD>
62d0cef73dSGregory Neil Shapiro</TR>
63e92d3f3fSGregory Neil Shapiro
64d0cef73dSGregory Neil Shapiro</TABLE>
65e92d3f3fSGregory Neil Shapiro
66d0cef73dSGregory Neil Shapiro<HR size="1">
67d0cef73dSGregory Neil Shapiro<FONT size="-1">
685dd76dd0SGregory Neil ShapiroCopyright (c) 2003, 2005 Proofpoint, Inc. and its suppliers.
69e92d3f3fSGregory Neil ShapiroAll rights reserved.
70d0cef73dSGregory Neil Shapiro<BR>
71e92d3f3fSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
72e92d3f3fSGregory Neil Shapiroforth in the LICENSE.
73d0cef73dSGregory Neil Shapiro</FONT>
74d0cef73dSGregory Neil Shapiro</BODY>
75d0cef73dSGregory Neil Shapiro</HTML>
76