79 lines
2.2 KiB
HTML
79 lines
2.2 KiB
HTML
<html>
|
|
<head><title>smfi_opensocket</title></head>
|
|
<body>
|
|
<!--
|
|
$Id: smfi_opensocket.html,v 1.4 2003/10/20 22:28:57 msk Exp $
|
|
-->
|
|
<h1>smfi_opensocket</h1>
|
|
|
|
<table border="0" cellspacing=4 cellpadding=4>
|
|
<!---------- Synopsis ----------->
|
|
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
|
|
<pre>
|
|
#include <libmilter/mfapi.h>
|
|
int smfi_opensocket(
|
|
bool rmsocket
|
|
);
|
|
</pre>
|
|
Attempt to create the interface socket MTAs will use to connect to the
|
|
filter.
|
|
</td></tr>
|
|
|
|
<!----------- Description ---------->
|
|
<tr><th valign="top" align=left>DESCRIPTION</th><td>
|
|
<table border="1" cellspacing=1 cellpadding=4>
|
|
<tr align="left" valign=top>
|
|
<th width="80">Called When</th>
|
|
<td>Called only from program mainline, before calling
|
|
<tt>smfi_main()</tt>.</td>
|
|
</tr>
|
|
<tr align="left" valign=top>
|
|
<th width="80">Effects</th>
|
|
<td>smfi_opensocket attempts to create the socket specified previously by
|
|
a call to <tt>smfi_setconn()</tt> which will be the interface between MTAs
|
|
and the filter. This allows the calling application to ensure that the
|
|
socket can be created. If this is not called, <tt>smfi_main()</tt> will
|
|
do so implicitly. </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!----------- Arguments ---------->
|
|
<tr><th valign="top" align=left>ARGUMENTS</th><td>
|
|
<table border="1" cellspacing=0>
|
|
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
|
|
<tr valign="top"><td>rmsocket</td>
|
|
<td>A flag indicating whether or not the library should try to
|
|
remove any existing UNIX domain socket before trying to create
|
|
a new one.
|
|
</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
|
|
<!----------- Return values ---------->
|
|
<tr>
|
|
<th valign="top" align=left>RETURN VALUES</th>
|
|
|
|
<td>smfi_opensocket will fail and return MI_FAILURE if:
|
|
<ul>
|
|
<li>The interface socket could not be created for any reason.
|
|
<li><tt>rmsocket</tt> was <tt>true</tt>, and either the socket could
|
|
not be examined, or exists and could not be removed.
|
|
<li><tt>smfi_setconn()</tt> has not been called.
|
|
</ul>
|
|
Otherwise, it will return MI_SUCCESS
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<hr size="1">
|
|
<font size="-1">
|
|
Copyright (c) 2003 Sendmail, Inc. and its suppliers.
|
|
All rights reserved.
|
|
<br>
|
|
By using this file, you agree to the terms and conditions set
|
|
forth in the LICENSE.
|
|
</font>
|
|
</body>
|
|
</html>
|