xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_main.html (revision 5ef517c097100c80269c8a0e02678a89fde6b35e)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>smfi_main</title></head>
340266059SGregory Neil Shapiro<body>
440266059SGregory Neil Shapiro<h1>smfi_main</h1>
540266059SGregory Neil Shapiro
640266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
740266059SGregory Neil Shapiro<!---------- Synopsis ----------->
840266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
940266059SGregory Neil Shapiro<pre>
1040266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1140266059SGregory Neil Shapiroint smfi_main(
1240266059SGregory Neil Shapiro);
1340266059SGregory Neil Shapiro</pre>
1440266059SGregory Neil ShapiroHand control to libmilter event loop.
1540266059SGregory Neil Shapiro</td></tr>
1640266059SGregory Neil Shapiro
1740266059SGregory Neil Shapiro<!----------- Description ---------->
1840266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
1940266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2040266059SGregory Neil Shapiro<tr align="left" valign=top>
2140266059SGregory Neil Shapiro<th width="80">Called When</th>
2240266059SGregory Neil Shapiro<td>smfi_main is called after a filter's initialization is complete.</td>
2340266059SGregory Neil Shapiro</tr>
2440266059SGregory Neil Shapiro<tr align="left" valign=top>
2540266059SGregory Neil Shapiro<th width="80">Effects</th>
2640266059SGregory Neil Shapiro<td>smfi_main hands control to the Milter event loop.</td>
2740266059SGregory Neil Shapiro</tr>
2840266059SGregory Neil Shapiro</table>
2940266059SGregory Neil Shapiro
3040266059SGregory Neil Shapiro<!----------- Return values ---------->
3140266059SGregory Neil Shapiro<tr>
3240266059SGregory Neil Shapiro<th valign="top" align=left>RETURN VALUES</th>
3340266059SGregory Neil Shapiro
3440266059SGregory Neil Shapiro<td>smfi_main will return MI_FAILURE if it fails to establish a connection.  This may occur for any of a variety of reasons (e.g. invalid address passed to <a href="smfi_setconn.html">smfi_setconn</a>).  The reason for the failure will be logged.  Otherwise, smfi_main will return MI_SUCCESS.</td>
3540266059SGregory Neil Shapiro</tr>
3640266059SGregory Neil Shapiro
3740266059SGregory Neil Shapiro</table>
3840266059SGregory Neil Shapiro
3940266059SGregory Neil Shapiro<hr size="1">
4040266059SGregory Neil Shapiro<font size="-1">
415ef517c0SGregory Neil ShapiroCopyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
4240266059SGregory Neil ShapiroAll rights reserved.
4340266059SGregory Neil Shapiro<br>
4440266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
455ef517c0SGregory Neil Shapiroforth in the LICENSE.
4640266059SGregory Neil Shapiro</font>
4740266059SGregory Neil Shapiro</body>
4840266059SGregory Neil Shapiro</html>
49