smfi_settimeout.html revision 182352 
1<HTML>
2<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
3<BODY>
4<!--
5$Id: smfi_settimeout.html,v 1.14 2006/12/21 18:30:35 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;
14int smfi_settimeout(
15	int otimeout
16);
17</PRE>
18Set 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
31for an MTA communication (read or write) before timing out.
32If 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</TABLE>
56
57<HR size="1">
58<FONT size="-1">
59Copyright (c) 2000, 2002-2003, 2006 Sendmail, Inc. and its suppliers.
60All rights reserved.
61<BR>
62By using this file, you agree to the terms and conditions set
63forth in the LICENSE.
64</FONT>
65</BODY>
66</HTML>
67