contrib/sendmail-8.13.6/libmilter/docs/smfi_settimeout.html

   1 <html>
   2 <head><title>smfi_settimeout</title></head>
   3 <body>
   4 <!--
   5 $Id: smfi_settimeout.html,v 1.11 2003/03/05 19:57:54 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=150>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 connection 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 for an MTA connection before
  31 timing out a socket.
  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).  Zero means
  43 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 </table>
  56
  57 <hr size="1">
  58 <font size="-1">
  59 Copyright (c) 2000, 2002-2003 Sendmail, Inc. and its suppliers.
  60 All rights reserved.
  61 <br>
  62 By using this file, you agree to the terms and conditions set
  63 forth in the LICENSE.
  64 </font>
  65 </body>
  66 </html>