2 <head><title>smfi_opensocket</title></head>
5 $Id: smfi_opensocket.html,v 1.4 2003/10/20 22:28:57 msk Exp $
7 <h1>smfi_opensocket</h1>
9 <table border="0" cellspacing=4 cellpadding=4>
10 <!---------- Synopsis ----------->
11 <tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
13 #include <libmilter/mfapi.h>
18 Attempt to create the interface socket MTAs will use to connect to the
22 <!----------- Description ---------->
23 <tr><th valign="top" align=left>DESCRIPTION</th><td>
24 <table border="1" cellspacing=1 cellpadding=4>
25 <tr align="left" valign=top>
26 <th width="80">Called When</th>
27 <td>Called only from program mainline, before calling
28 <tt>smfi_main()</tt>.</td>
30 <tr align="left" valign=top>
31 <th width="80">Effects</th>
32 <td>smfi_opensocket attempts to create the socket specified previously by
33 a call to <tt>smfi_setconn()</tt> which will be the interface between MTAs
34 and the filter. This allows the calling application to ensure that the
35 socket can be created. If this is not called, <tt>smfi_main()</tt> will
36 do so implicitly. </td>
40 <!----------- Arguments ---------->
41 <tr><th valign="top" align=left>ARGUMENTS</th><td>
42 <table border="1" cellspacing=0>
43 <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
44 <tr valign="top"><td>rmsocket</td>
45 <td>A flag indicating whether or not the library should try to
46 remove any existing UNIX domain socket before trying to create
52 <!----------- Return values ---------->
54 <th valign="top" align=left>RETURN VALUES</th>
56 <td>smfi_opensocket will fail and return MI_FAILURE if:
58 <li>The interface socket could not be created for any reason.
59 <li><tt>rmsocket</tt> was <tt>true</tt>, and either the socket could
60 not be examined, or exists and could not be removed.
61 <li><tt>smfi_setconn()</tt> has not been called.
63 Otherwise, it will return MI_SUCCESS
71 Copyright (c) 2003 Sendmail, Inc. and its suppliers.
74 By using this file, you agree to the terms and conditions set