smfi_settimeout.html revision 259065 
190792Sgshapiro<HTML>
2261194Sgshapiro<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
390792Sgshapiro<BODY>
490792Sgshapiro<!--
590792Sgshapiro$Id: smfi_settimeout.html,v 1.15 2011/10/03 16:21:33 ca Exp $
690792Sgshapiro-->
790792Sgshapiro<H1>smfi_settimeout</H1>
890792Sgshapiro
990792Sgshapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1090792Sgshapiro<!---------- Synopsis ----------->
11261194Sgshapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
1290792Sgshapiro<PRE>
1390792Sgshapiro#include &lt;libmilter/mfapi.h&gt;
1490792Sgshapiroint smfi_settimeout(
1590792Sgshapiro	int otimeout
1690792Sgshapiro);
1790792Sgshapiro</PRE>
1890792SgshapiroSet the filter's I/O timeout value.
1990792Sgshapiro</TD></TR>
2090792Sgshapiro
2190792Sgshapiro<!----------- Description ---------->
2290792Sgshapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
2390792Sgshapiro<TABLE border="1" cellspacing=1 cellpadding=4>
2490792Sgshapiro<TR align="left" valign=top>
2590792Sgshapiro<TH width="80">Called When</TH>
2690792Sgshapiro<TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
2790792Sgshapiro</TR>
2890792Sgshapiro<TR align="left" valign=top>
2990792Sgshapiro<TH width="80">Effects</TH>
3090792Sgshapiro<TD>Sets the number of seconds libmilter will wait
3190792Sgshapirofor an MTA communication (read or write) before timing out.
3290792SgshapiroIf smfi_settimeout is not called, a default timeout of 7210 seconds is used.
3390792Sgshapiro</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>
59Decreasing the timeout is strongly discouraged
60and may break the communication with the MTA.
61Do <EM>not</EM> decrease this value without making sure that
62the 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">
72Copyright (c) 2000, 2002-2003, 2006, 2011 Sendmail, Inc. and its suppliers.
73All rights reserved.
74<BR>
75By using this file, you agree to the terms and conditions set
76forth in the LICENSE.
77</FONT>
78</BODY>
79</HTML>
80