smfi_settimeout.html revision 266692 
11539Srgrimes<HTML>
21539Srgrimes<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
31539Srgrimes<BODY>
41539Srgrimes<!--
51539Srgrimes$Id: smfi_settimeout.html,v 1.16 2013-11-22 20:51:39 ca Exp $
61539Srgrimes-->
71539Srgrimes<H1>smfi_settimeout</H1>
81539Srgrimes
91539Srgrimes<TABLE border="0" cellspacing=4 cellpadding=4>
101539Srgrimes<!---------- Synopsis ----------->
111539Srgrimes<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
121539Srgrimes<PRE>
13203964Simp#include &lt;libmilter/mfapi.h&gt;
141539Srgrimesint smfi_settimeout(
151539Srgrimes	int otimeout
161539Srgrimes);
171539Srgrimes</PRE>
181539SrgrimesSet the filter's I/O timeout value.
191539Srgrimes</TD></TR>
201539Srgrimes
211539Srgrimes<!----------- Description ---------->
221539Srgrimes<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
231539Srgrimes<TABLE border="1" cellspacing=1 cellpadding=4>
241539Srgrimes<TR align="left" valign=top>
251539Srgrimes<TH width="80">Called When</TH>
261539Srgrimes<TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
271539Srgrimes</TR>
281539Srgrimes<TR align="left" valign=top>
2923657Speter<TH width="80">Effects</TH>
3055031Sbde<TD>Sets the number of seconds libmilter will wait
311539Srgrimesfor an MTA communication (read or write) before timing out.
321539SrgrimesIf smfi_settimeout is not called, a default timeout of 7210 seconds is used.
331539Srgrimes</TD>
347865Sbde</TR>
351539Srgrimes</TABLE>
3633861Sbde
37123257Smarcel<!----------- Arguments ---------->
38102227Smike<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
3933861Sbde    <TABLE border="1" cellspacing=0>
40103728Swollman    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
41102227Smike    <TR valign="top"><TD>otimeout</TD>
42102227Smike	<TD>The number of seconds to wait before timing out (&gt; 0).
43102227Smike	Zero means no wait, <B>not</B> "wait forever".
4415483Sbde	</TD></TR>
4515483Sbde    </TABLE>
4615483Sbde</TD></TR>
47102227Smike
48102227Smike<!----------- Return values ---------->
49102227Smike<TR>
501539Srgrimes<TH valign="top" align=left>RETURN VALUES</TH> 
511539Srgrimes
5299640Sobrien<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
53102227Smike</TR>
54102227Smike
55102227Smike<!----------- Notes ---------->
561539Srgrimes<TR>
5799640Sobrien<TH valign="top" align=left>NOTES</TH> 
581539Srgrimes<TD>
591539SrgrimesDecreasing the timeout is strongly discouraged
60103766Sbdeand may break the communication with the MTA.
61103766SbdeDo <EM>not</EM> decrease this value without making sure that
621539Srgrimesthe MTA also uses lower timeouts for communication
631539Srgrimes(with the milter and with the SMTP client).
641539Srgrimes</TR>
65103766Sbde</TABLE>
66103766Sbde
671539Srgrimes
681539Srgrimes</TABLE>
691539Srgrimes
701539Srgrimes<HR size="1">
711539Srgrimes<FONT size="-1">
721539SrgrimesCopyright (c) 2000, 2002-2003, 2006, 2011 Proofpoint, Inc. and its suppliers.
731539SrgrimesAll rights reserved.
74227753Stheraven<BR>
75233600StheravenBy using this file, you agree to the terms and conditions set
76233600Stheravenforth in the LICENSE.
77233600Stheraven</FONT>
781539Srgrimes</BODY>
79227753Stheraven</HTML>
80227753Stheraven