contrib/sendmail/libmilter/docs/smfi_settimeout.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_settimeout.html,v 1.15 2011/10/03 16:21:33 ca Exp $
   6 -->
   7 <H1>smfi_settimeout</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_settimeout(
  15         int otimeout
  16 );
  17 </PRE>
  18 Set the filter's I/O timeout value.
  19 </TD></TR>
  20
  21 <!----------- Description ---------->
  22 <TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
  23 <TABLE border="1" cellspacing=1 cellpadding=4>
  24 <TR align="left" valign=top>
  25 <TH width="80">Called When</TH>
  26 <TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
  27 </TR>
  28 <TR align="left" valign=top>
  29 <TH width="80">Effects</TH>
  30 <TD>Sets the number of seconds libmilter will wait
  31 for an MTA communication (read or write) before timing out.
  32 If smfi_settimeout is not called, a default timeout of 7210 seconds is used.
  33 </TD>
  34 </TR>
  35 </TABLE>
  36
  37 <!----------- Arguments ---------->
  38 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
  39     <TABLE border="1" cellspacing=0>
  40     <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
  41     <TR valign="top"><TD>otimeout</TD>
  42         <TD>The number of seconds to wait before timing out (&gt; 0).
  43         Zero means no wait, <B>not</B> "wait forever".
  44         </TD></TR>
  45     </TABLE>
  46 </TD></TR>
  47
  48 <!----------- Return values ---------->
  49 <TR>
  50 <TH valign="top" align=left>RETURN VALUES</TH>
  51
  52 <TD>smfi_settimeout always returns MI_SUCCESS.</TD>
  53 </TR>
  54
  55 <!----------- Notes ---------->
  56 <TR>
  57 <TH valign="top" align=left>NOTES</TH>
  58 <TD>
  59 Decreasing the timeout is strongly discouraged
  60 and may break the communication with the MTA.
  61 Do <EM>not</EM> decrease this value without making sure that
  62 the MTA also uses lower timeouts for communication
  63 (with the milter and with the SMTP client).
  64 </TR>
  65 </TABLE>
  66
  67
  68 </TABLE>
  69
  70 <HR size="1">
  71 <FONT size="-1">
  72 Copyright (c) 2000, 2002-2003, 2006, 2011 Sendmail, Inc. and its suppliers.
  73 All rights reserved.
  74 <BR>
  75 By using this file, you agree to the terms and conditions set
  76 forth in the LICENSE.
  77 </FONT>
  78 </BODY>
  79 </HTML>