smfi_settimeout.html revision 168515 
1167514Skmacy<HTML>
2167514Skmacy<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
3167514Skmacy<BODY>
4167514Skmacy<!--
5167514Skmacy$Id: smfi_settimeout.html,v 1.14 2006/12/21 18:30:35 ca Exp $
6167514Skmacy-->
7167514Skmacy<H1>smfi_settimeout</H1>
8167514Skmacy
9167514Skmacy<TABLE border="0" cellspacing=4 cellpadding=4>
10167514Skmacy<!---------- Synopsis ----------->
11167514Skmacy<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12169978Skmacy<PRE>
13167514Skmacy#include &lt;libmilter/mfapi.h&gt;
14167514Skmacyint smfi_settimeout(
15167514Skmacy	int otimeout
16167514Skmacy);
17167514Skmacy</PRE>
18167514SkmacySet the filter's I/O timeout value.
19167514Skmacy</TD></TR>
20167514Skmacy
21167514Skmacy<!----------- Description ---------->
22167514Skmacy<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
23167514Skmacy<TABLE border="1" cellspacing=1 cellpadding=4>
24167514Skmacy<TR align="left" valign=top>
25167514Skmacy<TH width="80">Called When</TH>
26167514Skmacy<TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
27167514Skmacy</TR>
28167514Skmacy<TR align="left" valign=top>
29167514Skmacy<TH width="80">Effects</TH>
30167514Skmacy<TD>Sets the number of seconds libmilter will wait
31167514Skmacyfor an MTA communication (read or write) before timing out.
32167514SkmacyIf smfi_settimeout is not called, a default timeout of 7210 seconds is used.
33167514Skmacy</TD>
34167514Skmacy</TR>
35167514Skmacy</TABLE>
36167514Skmacy
37167514Skmacy<!----------- Arguments ---------->
38167514Skmacy<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
39167514Skmacy    <TABLE border="1" cellspacing=0>
40167514Skmacy    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
41167514Skmacy    <TR valign="top"><TD>otimeout</TD>
42167514Skmacy	<TD>The number of seconds to wait before timing out (&gt; 0).
43167514Skmacy	Zero means no wait, <B>not</B> "wait forever".
44167514Skmacy	</TD></TR>
45167514Skmacy    </TABLE>
46167514Skmacy</TD></TR>
47167514Skmacy
48167514Skmacy<!----------- Return values ---------->
49167514Skmacy<TR>
50167514Skmacy<TH valign="top" align=left>RETURN VALUES</TH> 
51167514Skmacy
52167514Skmacy<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
53167514Skmacy</TR>
54167514Skmacy
55167514Skmacy</TABLE>
56167514Skmacy
57167514Skmacy<HR size="1">
58167514Skmacy<FONT size="-1">
59167514SkmacyCopyright (c) 2000, 2002-2003, 2006 Sendmail, Inc. and its suppliers.
60167514SkmacyAll rights reserved.
61167514Skmacy<BR>
62167514SkmacyBy using this file, you agree to the terms and conditions set
63167514Skmacyforth in the LICENSE.
64167514Skmacy</FONT>
65167514Skmacy</BODY>
66167514Skmacy</HTML>
67167514Skmacy