smfi_settimeout.html revision 90792
1<html>
2<head><title>smfi_settimeout</title></head>
3<body>
4<h1>smfi_settimeout</h1>
5
6<table border="0" cellspacing=4 cellpadding=4>
7<!---------- Synopsis ----------->
8<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
9<pre>
10#include &lt;libmilter/mfapi.h&gt;
11int smfi_settimeout(
12	int otimeout
13);
14</pre>
15Set the filter's connection timeout value.
16</td></tr>
17
18<!----------- Description ---------->
19<tr><th valign="top" align=left>DESCRIPTION</th><td>
20<table border="1" cellspacing=1 cellpadding=4>
21<tr align="left" valign=top>
22<th width="80">Called When</th>
23<td>smfi_settimeout should only be called before <a href="smfi_main.html">smfi_main</a>.</td>
24</tr>
25<tr align="left" valign=top>
26<th width="80">Effects</th>
27<td>Sets the number of seconds libmilter will wait for an MTA connection before timing out a socket.  If smfi_settimeout is not called, a default timeout of 1800 seconds is used.</td>
28</tr>
29</table>
30
31<!----------- Arguments ---------->
32<tr><th valign="top" align=left>ARGUMENTS</th><td>
33    <table border="1" cellspacing=0>
34    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
35    <tr valign="top"><td>otimeout</td>
36	<td>The number of seconds to wait before timing out (&gt; 0).  Zero means
37no wait, <b>not</b> "wait forever".
38	</td></tr>
39    </table>
40</td></tr>
41
42<!----------- Return values ---------->
43<tr>
44<th valign="top" align=left>RETURN VALUES</th> 
45
46<td>smfi_settimeout always returns MI_SUCCESS.</td>
47</tr>
48
49</table>
50
51<hr size="1">
52<font size="-1">
53Copyright (c) 2000 Sendmail, Inc. and its suppliers.
54All rights reserved.
55<br>
56By using this file, you agree to the terms and conditions set
57forth in the <a href="LICENSE.txt">LICENSE</a>.
58</font>
59</body>
60</html>
61