"Fossies" - the Fresh Open Source Software Archive

Member "sendmail-8.15.2/libmilter/docs/smfi_stop.html" (5 Mar 2014, 2024 Bytes) of package /linux/misc/sendmail.8.15.2.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    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;
   14 int smfi_stop(void);
   15 </PRE>
   16 Shutdown the milter.
   17 No 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
   26 or 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
   31 will be accepted,
   32 however, it does not wait for existing connections (threads) to terminate.
   33 It will cause
   34 <A href="smfi_main.html">smfi_main</A> to return to the calling program,
   35 which may then exit or warm-restart.
   36 </TD>
   37 </TR>
   38 </TABLE>
   39 
   40 <!----------- Arguments ---------->
   41 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
   42     <TABLE border="1" cellspacing=0>
   43     <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
   44     <TR valign="top"><TD>void</TD>
   45     <TD>Takes no argument.
   46     </TD></TR>
   47     </TABLE>
   48 </TD></TR>
   49 
   50 <!----------- Return values ---------->
   51 <TR>
   52 <TH valign="top" align=left>RETURN VALUES</TH> 
   53 
   54 <TD>smfi_stop always returns SMFI_CONTINUE. But note:
   55 <UL>
   56     <LI>Another internal routine may already have asked the milter to abort.
   57     <LI>Another routine may already have asked the milter to stop.
   58     <LI>There is no way to cancel the stop process once it has begun.
   59 </UL>
   60 </TD>
   61 </TR>
   62 
   63 </TABLE>
   64 
   65 <HR size="1">
   66 <FONT size="-1">
   67 Copyright (c) 2003, 2005 Proofpoint, Inc. and its suppliers.
   68 All rights reserved.
   69 <BR>
   70 By using this file, you agree to the terms and conditions set
   71 forth in the LICENSE.
   72 </FONT>
   73 </BODY>
   74 </HTML>