xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_progress.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_progress</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: smfi_progress.html,v 1.6 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_progress</H1>
8e92d3f3fSGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
10e92d3f3fSGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
13e92d3f3fSGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
14e92d3f3fSGregory Neil Shapiroint smfi_progress(
15e92d3f3fSGregory Neil Shapiro	SMFICTX *ctx;
16e92d3f3fSGregory Neil Shapiro);
17d0cef73dSGregory Neil Shapiro</PRE>
18e92d3f3fSGregory Neil ShapiroNotify the MTA that an operation is still in progress.
19d0cef73dSGregory Neil Shapiro</TD></TR>
20e92d3f3fSGregory Neil Shapiro
21e92d3f3fSGregory Neil Shapiro<!----------- Description ---------->
22d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
23d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
24d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
25d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
26d0cef73dSGregory Neil Shapiro<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
27d0cef73dSGregory Neil Shapiro</TR>
28d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
29d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
30d0cef73dSGregory Neil Shapiro<TD>smfi_progress notifies the MTA that the filter is still working
31d0cef73dSGregory Neil Shapiroon a message, causing the MTA to re-start its timeouts.</TD>
32d0cef73dSGregory Neil Shapiro</TR>
33d0cef73dSGregory Neil Shapiro</TABLE>
34*5b0945b5SGregory Neil Shapiro</TD></TR>
35e92d3f3fSGregory Neil Shapiro
36e92d3f3fSGregory Neil Shapiro<!----------- Arguments ---------->
37d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
39d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
41d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
42d0cef73dSGregory Neil Shapiro	</TD></TR>
43d0cef73dSGregory Neil Shapiro    </TABLE>
44d0cef73dSGregory Neil Shapiro</TD></TR>
45e92d3f3fSGregory Neil Shapiro
46e92d3f3fSGregory Neil Shapiro<!----------- Return values ---------->
47d0cef73dSGregory Neil Shapiro<TR>
48d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
49e92d3f3fSGregory Neil Shapiro
50d0cef73dSGregory Neil Shapiro<TD>smfi_progress will fail and return MI_FAILURE if:
51d0cef73dSGregory Neil Shapiro<UL>
52d0cef73dSGregory Neil Shapiro    <LI>A network error occurs.
53d0cef73dSGregory Neil Shapiro</UL>
54e92d3f3fSGregory Neil ShapiroOtherwise, it will return MI_SUCCESS
55d0cef73dSGregory Neil Shapiro</TD>
56d0cef73dSGregory Neil Shapiro</TR>
57e92d3f3fSGregory Neil Shapiro
58d0cef73dSGregory Neil Shapiro</TABLE>
59e92d3f3fSGregory Neil Shapiro
60d0cef73dSGregory Neil Shapiro<HR size="1">
61d0cef73dSGregory Neil Shapiro<FONT size="-1">
625dd76dd0SGregory Neil ShapiroCopyright (c) 2003 Proofpoint, Inc. and its suppliers.
63e92d3f3fSGregory Neil ShapiroAll rights reserved.
64d0cef73dSGregory Neil Shapiro<BR>
65e92d3f3fSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
66e92d3f3fSGregory Neil Shapiroforth in the LICENSE.
67d0cef73dSGregory Neil Shapiro</FONT>
68d0cef73dSGregory Neil Shapiro</BODY>
69d0cef73dSGregory Neil Shapiro</HTML>
70