11553Srgrimes<HTML>
21553Srgrimes<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
31553Srgrimes<BODY>
41553Srgrimes<!--
51553Srgrimes$Id: smfi_settimeout.html,v 1.15 2011/10/03 16:21:33 ca Exp $
61553Srgrimes-->
71553Srgrimes<H1>smfi_settimeout</H1>
81553Srgrimes
91553Srgrimes<TABLE border="0" cellspacing=4 cellpadding=4>
101553Srgrimes<!---------- Synopsis ----------->
111553Srgrimes<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
121553Srgrimes<PRE>
131553Srgrimes#include &lt;libmilter/mfapi.h&gt;
141553Srgrimesint smfi_settimeout(
151553Srgrimes	int otimeout
161553Srgrimes);
171553Srgrimes</PRE>
181553SrgrimesSet the filter's I/O timeout value.
191553Srgrimes</TD></TR>
201553Srgrimes
211553Srgrimes<!----------- Description ---------->
221553Srgrimes<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
231553Srgrimes<TABLE border="1" cellspacing=1 cellpadding=4>
241553Srgrimes<TR align="left" valign=top>
251553Srgrimes<TH width="80">Called When</TH>
261553Srgrimes<TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
271553Srgrimes</TR>
281553Srgrimes<TR align="left" valign=top>
291553Srgrimes<TH width="80">Effects</TH>
301553Srgrimes<TD>Sets the number of seconds libmilter will wait
311553Srgrimesfor an MTA communication (read or write) before timing out.
321553SrgrimesIf smfi_settimeout is not called, a default timeout of 7210 seconds is used.
331553Srgrimes</TD>
341553Srgrimes</TR>
3530642Scharnier</TABLE>
361553Srgrimes
3730642Scharnier<!----------- Arguments ---------->
3830642Scharnier<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
3950479Speter    <TABLE border="1" cellspacing=0>
401553Srgrimes    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
411553Srgrimes    <TR valign="top"><TD>otimeout</TD>
421553Srgrimes	<TD>The number of seconds to wait before timing out (&gt; 0).
431553Srgrimes	Zero means no wait, <B>not</B> "wait forever".
441553Srgrimes	</TD></TR>
4590868Smike    </TABLE>
4690868Smike</TD></TR>
471553Srgrimes
481553Srgrimes<!----------- Return values ---------->
491553Srgrimes<TR>
501553Srgrimes<TH valign="top" align=left>RETURN VALUES</TH> 
5130642Scharnier
521553Srgrimes<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
53116078Simp</TR>
541553Srgrimes
551553Srgrimes<!----------- Notes ---------->
561553Srgrimes<TR>
571553Srgrimes<TH valign="top" align=left>NOTES</TH> 
581553Srgrimes<TD>
591553SrgrimesDecreasing the timeout is strongly discouraged
601553Srgrimesand may break the communication with the MTA.
611553SrgrimesDo <EM>not</EM> decrease this value without making sure that
621553Srgrimesthe MTA also uses lower timeouts for communication
631553Srgrimes(with the milter and with the SMTP client).
641553Srgrimes</TR>
651553Srgrimes</TABLE>
661553Srgrimes
671553Srgrimes
6830872Scharnier</TABLE>
691553Srgrimes
701553Srgrimes<HR size="1">
711553Srgrimes<FONT size="-1">
721553SrgrimesCopyright (c) 2000, 2002-2003, 2006, 2011 Sendmail, Inc. and its suppliers.
731553SrgrimesAll rights reserved.
741553Srgrimes<BR>
751553SrgrimesBy using this file, you agree to the terms and conditions set
761553Srgrimesforth in the LICENSE.
771553Srgrimes</FONT>
781611Srgrimes</BODY>
791553Srgrimes</HTML>
801553Srgrimes