1<html>
2<head><title>smfi_opensocket</title></head>
3<body>
| 1<HTML>
2<HEAD><TITLE>smfi_opensocket</TITLE></HEAD>
3<BODY>
|
4<!--
| 4<!--
|
5$Id: smfi_opensocket.html,v 1.4 2003/10/20 22:28:57 msk Exp $
| 5$Id: smfi_opensocket.html,v 1.6 2006/12/21 18:30:35 ca Exp $
|
6-->
| 6-->
|
7<h1>smfi_opensocket</h1>
| 7<H1>smfi_opensocket</H1>
|
8
| 8
|
9<table border="0" cellspacing=4 cellpadding=4>
| 9<TABLE border="0" cellspacing=4 cellpadding=4>
|
10<!---------- Synopsis ----------->
| 10<!---------- Synopsis ----------->
|
11<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12<pre>
| 11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12<PRE>
|
13#include <libmilter/mfapi.h>
14int smfi_opensocket(
15 bool rmsocket
16);
| 13#include <libmilter/mfapi.h>
14int smfi_opensocket(
15 bool rmsocket
16);
|
17</pre>
| 17</PRE>
|
18Attempt to create the interface socket MTAs will use to connect to the
19filter.
| 18Attempt to create the interface socket MTAs will use to connect to the
19filter.
|
20</td></tr>
| 20</TD></TR>
|
21
22<!----------- Description ---------->
| 21
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>
29</tr>
30<tr align="left" valign=top>
31<th width="80">Effects</th>
32<td>smfi_opensocket attempts to create the socket specified previously by
33a call to <tt>smfi_setconn()</tt> which will be the interface between MTAs
| 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>
29</TR>
30<TR align="left" valign=top>
31<TH width="80">Effects</TH>
32<TD>smfi_opensocket attempts to create the socket specified previously by
33a call to <TT>smfi_setconn()</TT> which will be the interface between MTAs
|
34and the filter. This allows the calling application to ensure that the
| 34and the filter. This allows the calling application to ensure that the
|
35socket can be created. If this is not called, <tt>smfi_main()</tt> will
36do so implicitly. </td>
37</tr>
38</table>
| 35socket can be created. If this is not called, <TT>smfi_main()</TT> will
36do so implicitly. </TD>
37</TR>
38</TABLE>
|
39
40<!----------- Arguments ---------->
| 39
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
| 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
47 a new one.
| 46 remove any existing UNIX domain socket before trying to create
47 a new one.
|
48 </td></tr>
49 </table>
50</td></tr>
| 48 </TD></TR>
49 </TABLE>
50</TD></TR>
|
51
52<!----------- Return values ---------->
| 51
52<!----------- Return values ---------->
|
53<tr>
54<th valign="top" align=left>RETURN VALUES</th>
| 53<TR>
54<TH valign="top" align=left>RETURN VALUES</TH>
|
55
| 55
|
56<td>smfi_opensocket will fail and return MI_FAILURE if:
57<ul>
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
| 56<TD>smfi_opensocket will fail and return MI_FAILURE if:
57<UL>
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.
| 60 not be examined, or exists and could not be removed.
|
61 <li><tt>smfi_setconn()</tt> has not been called.
62</ul>
| 61 <LI><TT>smfi_setconn()</TT> has not been called.
62</UL>
|
63Otherwise, it will return MI_SUCCESS
| 63Otherwise, it will return MI_SUCCESS
|
64</td>
65</tr>
| 64</TD>
65</TR>
|
66
| 66
|
67</table>
| 67</TABLE>
|
68
| 68
|
69<hr size="1">
70<font size="-1">
| 69<HR size="1">
70<FONT size="-1">
|
71Copyright (c) 2003 Sendmail, Inc. and its suppliers.
72All rights reserved.
| 71Copyright (c) 2003 Sendmail, Inc. and its suppliers.
72All rights reserved.
|
73<br>
| 73<BR>
|
74By using this file, you agree to the terms and conditions set
75forth in the LICENSE.
| 74By using this file, you agree to the terms and conditions set
75forth in the LICENSE.
|
76</font>
77</body>
78</html>
| 76</FONT>
77</BODY>
78</HTML>
|
| |