smfi_stop.html revision 266692
11638Srgrimes<HTML>
252331Sache<HEAD><TITLE>smfi_stop</TITLE></HEAD>
31638Srgrimes<BODY>
4156813Sru<!--
5156813Sru$Id: smfi_stop.html,v 1.8 2013-11-22 20:51:39 ca Exp $
656296Sru-->
756296Sru<H1>smfi_stop</H1>
8256366Srpaulo
9145003Sphk<TABLE border="0" cellspacing=4 cellpadding=4>
10124750Sru<!---------- Synopsis ----------->
11235613Sgnn<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12148675Sphk<PRE>
13219019Sgabor#include &lt;libmilter/mfapi.h&gt;
14257572Sbdreweryint smfi_stop(void);
15148675Sphk</PRE>
16148675SphkShutdown the milter.
17124750SruNo connections will be accepted after this call.
18183242Ssam</TD></TR>
19148736Sphk
20148736Sphk<!----------- Description ---------->
21148736Sphk<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
22148736Sphk<TABLE border="1" cellspacing=1 cellpadding=4>
23124750Sru<TR align="left" valign=top>
24124750Sru<TH width="80">Called When</TH>
25183242Ssam<TD>Called from any of the <A href="api.html#Callbacks">Callback</A> routines
26148675Sphkor any error-handling routines at any time.</TD>
27124750Sru</TR>
28124750Sru<TR align="left" valign=top>
29148736Sphk<TH width="80">Effects</TH>
30171050Sremko<TD>The smfi_stop routine prevents that new connections
311638Srgrimeswill be accepted,
32183242Ssamhowever, it does not wait for existing connections (threads) to terminate.
33183242SsamIt will cause
34183242Ssam<A href="smfi_main.html">smfi_main</A> to return to the calling program,
35183242Ssamwhich may then exit or warm-restart.
36183242Ssam</TD>
37183242Ssam</TR>
38183242Ssam</TABLE>
39183697Sdes
40183242Ssam<!----------- Arguments ---------->
41183242Ssam<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
42183242Ssam    <TABLE border="1" cellspacing=0>
43183242Ssam    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
44183242Ssam    <TR valign="top"><TD>void</TD>
45183242Ssam	<TD>Takes no argument.
46183242Ssam	</TD></TR>
47183242Ssam    </TABLE>
48183242Ssam</TD></TR>
49183242Ssam
50219019Sgabor<!----------- Return values ---------->
51219019Sgabor<TR>
52219019Sgabor<TH valign="top" align=left>RETURN VALUES</TH> 
53219019Sgabor
54156813Sru<TD>smfi_stop always returns SMFI_CONTINUE. But note:
55148736Sphk<UL>
56148736Sphk    <LI>Another internal routine may already have asked the milter to abort.
57148736Sphk    <LI>Another routine may already have asked the milter to stop.
58148736Sphk    <LI>There is no way to cancel the stop process once it has begun.
59148736Sphk</UL>
60148736Sphk</TD>
61148736Sphk</TR>
62148736Sphk
63183242Ssam</TABLE>
64183242Ssam
65148675Sphk<HR size="1">
66148675Sphk<FONT size="-1">
67156813SruCopyright (c) 2003, 2005 Proofpoint, Inc. and its suppliers.
68148675SphkAll rights reserved.
69148675Sphk<BR>
70148675SphkBy using this file, you agree to the terms and conditions set
71156813Sruforth in the LICENSE.
72124750Sru</FONT>
7366940Sgshapiro</BODY>
7466940Sgshapiro</HTML>
75156813Sru