xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_settimeout.html (revision 729362425c09cf6b362366aabc6fb547eee8035a)
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
28timing out a socket.
29If smfi_settimeout is not called, a default timeout of 7210 seconds is used.
30</td>
31</tr>
32</table>
33
34<!----------- Arguments ---------->
35<tr><th valign="top" align=left>ARGUMENTS</th><td>
36    <table border="1" cellspacing=0>
37    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
38    <tr valign="top"><td>otimeout</td>
39	<td>The number of seconds to wait before timing out (&gt; 0).  Zero means
40no wait, <b>not</b> "wait forever".
41	</td></tr>
42    </table>
43</td></tr>
44
45<!----------- Return values ---------->
46<tr>
47<th valign="top" align=left>RETURN VALUES</th>
48
49<td>smfi_settimeout always returns MI_SUCCESS.</td>
50</tr>
51
52</table>
53
54<hr size="1">
55<font size="-1">
56Copyright (c) 2000, 2002-2003 Sendmail, Inc. and its suppliers.
57All rights reserved.
58<br>
59By using this file, you agree to the terms and conditions set
60forth in the LICENSE.
61</font>
62</body>
63</html>
64