2 <HEAD><TITLE>smfi_opensocket</TITLE></HEAD>
5 $Id: smfi_opensocket.html,v 1.8 2013-11-22 20:51:39 ca Exp $
7 <H1>smfi_opensocket</H1>
9 <TABLE border="0" cellspacing=4 cellpadding=4>
10 <!---------- Synopsis ----------->
11 <TR><TH valign="top" align=left width=100>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,
28 after calling <TT>smfi_setconn()</TT> and <TT>smfi_register()</TT>,
29 but before calling <TT>smfi_main()</TT>.
32 <TR align="left" valign=top>
33 <TH width="80">Effects</TH>
34 <TD>smfi_opensocket attempts to create the socket specified previously by
35 a call to <TT>smfi_setconn()</TT> which will be the interface between MTAs
37 This allows the calling application to ensure that the socket can be created.
38 If this is not called,
39 <TT>smfi_main()</TT> will create the socket implicitly
40 (without removing a potentially existing UNIX domain socket).
46 <!----------- Arguments ---------->
47 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
48 <TABLE border="1" cellspacing=0>
49 <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
50 <TR valign="top"><TD>rmsocket</TD>
51 <TD>A flag indicating whether or not the library should try to
52 remove any existing UNIX domain socket before trying to create
58 <!----------- Return values ---------->
60 <TH valign="top" align=left>RETURN VALUES</TH>
62 <TD>smfi_opensocket will fail and return MI_FAILURE if:
64 <LI>The interface socket could not be created for any reason.
65 <LI><TT>rmsocket</TT> was <TT>true</TT>, and either the socket could
66 not be examined, or exists and could not be removed.
67 <LI><TT>smfi_setconn()</TT> or <TT>smfi_register()</TT>
70 Otherwise, it will return MI_SUCCESS
78 Copyright (c) 2003, 2008 Proofpoint, Inc. and its suppliers.
81 By using this file, you agree to the terms and conditions set