xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_settimeout.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: smfi_settimeout.html,v 1.16 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_settimeout</H1>
840266059SGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapiroint smfi_settimeout(
1540266059SGregory Neil Shapiro	int otimeout
1640266059SGregory Neil Shapiro);
17d0cef73dSGregory Neil Shapiro</PRE>
18d0cef73dSGregory Neil ShapiroSet the filter's I/O timeout value.
19d0cef73dSGregory Neil Shapiro</TD></TR>
2040266059SGregory Neil Shapiro
2140266059SGregory Neil Shapiro<!----------- Description ---------->
22d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
23d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
24d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
25d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
26d0cef73dSGregory Neil Shapiro<TD>smfi_settimeout should only be called before <A href="smfi_main.html">smfi_main</A>.</TD>
27d0cef73dSGregory Neil Shapiro</TR>
28d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
29d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
30d0cef73dSGregory Neil Shapiro<TD>Sets the number of seconds libmilter will wait
31d0cef73dSGregory Neil Shapirofor an MTA communication (read or write) before timing out.
3213bd1963SGregory Neil ShapiroIf smfi_settimeout is not called, a default timeout of 7210 seconds is used.
33d0cef73dSGregory Neil Shapiro</TD>
34d0cef73dSGregory Neil Shapiro</TR>
35d0cef73dSGregory Neil Shapiro</TABLE>
36*5b0945b5SGregory Neil Shapiro</TD></TR>
3740266059SGregory Neil Shapiro
3840266059SGregory Neil Shapiro<!----------- Arguments ---------->
39d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
40d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
41d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
42d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>otimeout</TD>
43d0cef73dSGregory Neil Shapiro	<TD>The number of seconds to wait before timing out (&gt; 0).
44d0cef73dSGregory Neil Shapiro	Zero means no wait, <B>not</B> "wait forever".
45d0cef73dSGregory Neil Shapiro	</TD></TR>
46d0cef73dSGregory Neil Shapiro    </TABLE>
47d0cef73dSGregory Neil Shapiro</TD></TR>
4840266059SGregory Neil Shapiro
4940266059SGregory Neil Shapiro<!----------- Return values ---------->
50d0cef73dSGregory Neil Shapiro<TR>
51d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
5240266059SGregory Neil Shapiro
53d0cef73dSGregory Neil Shapiro<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
54d0cef73dSGregory Neil Shapiro</TR>
5540266059SGregory Neil Shapiro
56ba00ec3dSGregory Neil Shapiro<!----------- Notes ---------->
57ba00ec3dSGregory Neil Shapiro<TR>
58ba00ec3dSGregory Neil Shapiro<TH valign="top" align=left>NOTES</TH>
59ba00ec3dSGregory Neil Shapiro<TD>
60ba00ec3dSGregory Neil ShapiroDecreasing the timeout is strongly discouraged
61ba00ec3dSGregory Neil Shapiroand may break the communication with the MTA.
62ba00ec3dSGregory Neil ShapiroDo <EM>not</EM> decrease this value without making sure that
63ba00ec3dSGregory Neil Shapirothe MTA also uses lower timeouts for communication
64ba00ec3dSGregory Neil Shapiro(with the milter and with the SMTP client).
65*5b0945b5SGregory Neil Shapiro</TD></TR>
66d0cef73dSGregory Neil Shapiro</TABLE>
6740266059SGregory Neil Shapiro
68d0cef73dSGregory Neil Shapiro<HR size="1">
69d0cef73dSGregory Neil Shapiro<FONT size="-1">
705dd76dd0SGregory Neil ShapiroCopyright (c) 2000, 2002-2003, 2006, 2011 Proofpoint, Inc. and its suppliers.
7140266059SGregory Neil ShapiroAll rights reserved.
72d0cef73dSGregory Neil Shapiro<BR>
7340266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
745ef517c0SGregory Neil Shapiroforth in the LICENSE.
75d0cef73dSGregory Neil Shapiro</FONT>
76d0cef73dSGregory Neil Shapiro</BODY>
77d0cef73dSGregory Neil Shapiro</HTML>
78