opnsense-src/contrib/sendmail/libmilter/docs/smfi_settimeout.html

67 lines
1.7 KiB
HTML
Raw Normal View History

2007-04-08 21:38:51 -04:00
<HTML>
<HEAD><TITLE>smfi_settimeout</TITLE></HEAD>
<BODY>
2004-07-31 21:04:57 -04:00
<!--
2007-04-08 21:38:51 -04:00
$Id: smfi_settimeout.html,v 1.14 2006/12/21 18:30:35 ca Exp $
2004-07-31 21:04:57 -04:00
-->
2007-04-08 21:38:51 -04:00
<H1>smfi_settimeout</H1>
2002-02-17 16:56:45 -05:00
2007-04-08 21:38:51 -04:00
<TABLE border="0" cellspacing=4 cellpadding=4>
2002-02-17 16:56:45 -05:00
<!---------- Synopsis ----------->
2007-04-08 21:38:51 -04:00
<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
<PRE>
2002-02-17 16:56:45 -05:00
#include &lt;libmilter/mfapi.h&gt;
int smfi_settimeout(
int otimeout
);
2007-04-08 21:38:51 -04:00
</PRE>
Set the filter's I/O timeout value.
</TD></TR>
2002-02-17 16:56:45 -05:00
<!----------- Description ---------->
2007-04-08 21:38:51 -04:00
<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.
2003-02-08 15:31:29 -05:00
If smfi_settimeout is not called, a default timeout of 7210 seconds is used.
2007-04-08 21:38:51 -04:00
</TD>
</TR>
</TABLE>
2002-02-17 16:56:45 -05:00
<!----------- Arguments ---------->
2007-04-08 21:38:51 -04:00
<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 (&gt; 0).
Zero means no wait, <B>not</B> "wait forever".
</TD></TR>
</TABLE>
</TD></TR>
2002-02-17 16:56:45 -05:00
<!----------- Return values ---------->
2007-04-08 21:38:51 -04:00
<TR>
<TH valign="top" align=left>RETURN VALUES</TH>
2002-02-17 16:56:45 -05:00
2007-04-08 21:38:51 -04:00
<TD>smfi_settimeout always returns MI_SUCCESS.</TD>
</TR>
2002-02-17 16:56:45 -05:00
2007-04-08 21:38:51 -04:00
</TABLE>
2002-02-17 16:56:45 -05:00
2007-04-08 21:38:51 -04:00
<HR size="1">
<FONT size="-1">
Copyright (c) 2000, 2002-2003, 2006 Sendmail, Inc. and its suppliers.
2002-02-17 16:56:45 -05:00
All rights reserved.
2007-04-08 21:38:51 -04:00
<BR>
2002-02-17 16:56:45 -05:00
By using this file, you agree to the terms and conditions set
2003-03-29 14:12:53 -05:00
forth in the LICENSE.
2007-04-08 21:38:51 -04:00
</FONT>
</BODY>
</HTML>