Includes build infrastructure & config updates required for changes in 8.16.1 MFC after: 5 days
78 lines
2.1 KiB
HTML
78 lines
2.1 KiB
HTML
<HTML>
|
|
<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
|
|
<BODY>
|
|
<!--
|
|
$Id: smfi_settimeout.html,v 1.16 2013-11-22 20:51:39 ca Exp $
|
|
-->
|
|
<H1>smfi_settimeout</H1>
|
|
|
|
<TABLE border="0" cellspacing=4 cellpadding=4>
|
|
<!---------- Synopsis ----------->
|
|
<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
|
|
<PRE>
|
|
#include <libmilter/mfapi.h>
|
|
int smfi_settimeout(
|
|
int otimeout
|
|
);
|
|
</PRE>
|
|
Set the filter's I/O timeout value.
|
|
</TD></TR>
|
|
|
|
<!----------- Description ---------->
|
|
<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
|
|
<TABLE border="1" cellspacing=1 cellpadding=4>
|
|
<TR align="left" valign=top>
|
|
<TH width="80">Called When</TH>
|
|
<TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
|
|
</TR>
|
|
<TR align="left" valign=top>
|
|
<TH width="80">Effects</TH>
|
|
<TD>Sets the number of seconds libmilter will wait
|
|
for an MTA communication (read or write) before timing out.
|
|
If smfi_settimeout is not called, a default timeout of 7210 seconds is used.
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD></TR>
|
|
|
|
<!----------- Arguments ---------->
|
|
<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
|
|
<TABLE border="1" cellspacing=0>
|
|
<TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
|
|
<TR valign="top"><TD>otimeout</TD>
|
|
<TD>The number of seconds to wait before timing out (> 0).
|
|
Zero means no wait, <B>not</B> "wait forever".
|
|
</TD></TR>
|
|
</TABLE>
|
|
</TD></TR>
|
|
|
|
<!----------- Return values ---------->
|
|
<TR>
|
|
<TH valign="top" align=left>RETURN VALUES</TH>
|
|
|
|
<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
|
|
</TR>
|
|
|
|
<!----------- Notes ---------->
|
|
<TR>
|
|
<TH valign="top" align=left>NOTES</TH>
|
|
<TD>
|
|
Decreasing the timeout is strongly discouraged
|
|
and may break the communication with the MTA.
|
|
Do <EM>not</EM> decrease this value without making sure that
|
|
the MTA also uses lower timeouts for communication
|
|
(with the milter and with the SMTP client).
|
|
</TD></TR>
|
|
</TABLE>
|
|
|
|
<HR size="1">
|
|
<FONT size="-1">
|
|
Copyright (c) 2000, 2002-2003, 2006, 2011 Proofpoint, Inc. and its suppliers.
|
|
All rights reserved.
|
|
<BR>
|
|
By using this file, you agree to the terms and conditions set
|
|
forth in the LICENSE.
|
|
</FONT>
|
|
</BODY>
|
|
</HTML>
|