smfi_settimeout.html revision 363466 
1<HTML>
2<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
3<BODY>
4<!--
5$Id: smfi_settimeout.html,v 1.16 2013-11-22 20:51:39 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</TD></TR>
37
38<!----------- Arguments ---------->
39<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
40    <TABLE border="1" cellspacing=0>
41    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
42    <TR valign="top"><TD>otimeout</TD>
43	<TD>The number of seconds to wait before timing out (&gt; 0).
44	Zero means no wait, <B>not</B> "wait forever".
45	</TD></TR>
46    </TABLE>
47</TD></TR>
48
49<!----------- Return values ---------->
50<TR>
51<TH valign="top" align=left>RETURN VALUES</TH>
52
53<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
54</TR>
55
56<!----------- Notes ---------->
57<TR>
58<TH valign="top" align=left>NOTES</TH>
59<TD>
60Decreasing the timeout is strongly discouraged
61and may break the communication with the MTA.
62Do <EM>not</EM> decrease this value without making sure that
63the MTA also uses lower timeouts for communication
64(with the milter and with the SMTP client).
65</TD></TR>
66</TABLE>
67
68<HR size="1">
69<FONT size="-1">
70Copyright (c) 2000, 2002-2003, 2006, 2011 Proofpoint, Inc. and its suppliers.
71All rights reserved.
72<BR>
73By using this file, you agree to the terms and conditions set
74forth in the LICENSE.
75</FONT>
76</BODY>
77</HTML>
78