smfi_stop.html revision 132943
1<html> 2<head><title>smfi_stop</title></head> 3<body> 4<!-- 5$Id: smfi_stop.html,v 1.2 2003/11/24 23:38:26 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 <libmilter/mfapi.h> 14int smfi_stop(void); 15</pre> 16Start an orderly shutdown of the milter. No connections will be accepted 17after 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 31causes each thread to finish its current connection, then exit. 32When all threads have exited, the call 33to <a href="smfi_main.html">smfi_main</a> returns to your calling program, 34which may then exit or warm-restart. 35</td> 36</tr> 37</table> 38 39<!----------- Arguments ----------> 40<tr><th valign="top" align=left>ARGUMENTS</th><td> 41 <table border="1" cellspacing=0> 42 <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr> 43 <tr valign="top"><td>void</td> 44 <td>Takes no arguement. 45 </td></tr> 46 </table> 47</td></tr> 48 49<!----------- Return values ----------> 50<tr> 51<th valign="top" align=left>RETURN VALUES</th> 52 53<td>smfi_stop always returns SMFI_CONTINUE. But note: 54<ul> 55 <li>Another internal routine may already have asked the milter to abort. 56 <li>Another routine may already have asked the milter to stop. 57 <li>There is no way to cancel the stop process once it has begun. 58</ul> 59</td> 60</tr> 61 62</table> 63 64<hr size="1"> 65<font size="-1"> 66Copyright (c) 2003 Sendmail, Inc. and its suppliers. 67All rights reserved. 68<br> 69By using this file, you agree to the terms and conditions set 70forth in the LICENSE. 71</font> 72</body> 73</html> 74