diff options
| author | Todd C. Miller <millert@cvs.openbsd.org> | 2004-06-24 03:59:29 +0000 |
|---|---|---|
| committer | Todd C. Miller <millert@cvs.openbsd.org> | 2004-06-24 03:59:29 +0000 |
| commit | 700c63457f17cd807c1f10effadddf89638c8258 (patch) | |
| tree | c610339d5a972c74aaab5b63110f916bad0dc0be /gnu/usr.sbin/sendmail/libmilter/docs/smfi_stop.html | |
| parent | 42d2671ccee983bc79c99c98837fc58abd068775 (diff) | |
Update to sendmail.8.13.0
Diffstat (limited to 'gnu/usr.sbin/sendmail/libmilter/docs/smfi_stop.html')
| -rw-r--r-- | gnu/usr.sbin/sendmail/libmilter/docs/smfi_stop.html | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/gnu/usr.sbin/sendmail/libmilter/docs/smfi_stop.html b/gnu/usr.sbin/sendmail/libmilter/docs/smfi_stop.html new file mode 100644 index 00000000000..42110c99e95 --- /dev/null +++ b/gnu/usr.sbin/sendmail/libmilter/docs/smfi_stop.html @@ -0,0 +1,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> |