xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_abort.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>xxfi_abort</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: xxfi_abort.html,v 1.13 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>xxfi_abort</H1>
840266059SGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapirosfsistat (*xxfi_abort)(
1540266059SGregory Neil Shapiro	SMFICTX *ctx
1640266059SGregory Neil Shapiro);
17d0cef73dSGregory Neil Shapiro</PRE>
1840266059SGregory Neil ShapiroHandle the current message's being aborted.
19d0cef73dSGregory Neil Shapiro</TD></TR>
2040266059SGregory Neil Shapiro
2140266059SGregory 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>xxfi_abort may be called at any time during message processing (i.e. between some message-oriented routine and <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>Default Behavior</TH>
30d0cef73dSGregory Neil Shapiro<TD>Do nothing; return SMFIS_CONTINUE.</TD>
31d0cef73dSGregory Neil Shapiro</TR>
32d0cef73dSGregory Neil Shapiro</TABLE>
33*5b0945b5SGregory Neil Shapiro</TD></TR>
3440266059SGregory Neil Shapiro
3540266059SGregory Neil Shapiro<!----------- Arguments ---------->
36d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
38d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
40d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
41d0cef73dSGregory Neil Shapiro	</TD></TR>
42d0cef73dSGregory Neil Shapiro    </TABLE>
43d0cef73dSGregory Neil Shapiro</TD></TR>
4440266059SGregory Neil Shapiro
4540266059SGregory Neil Shapiro<!----------- Notes ---------->
46d0cef73dSGregory Neil Shapiro<TR>
47d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>NOTES</TH>
48d0cef73dSGregory Neil Shapiro<TD>
49d0cef73dSGregory Neil Shapiro<UL>
50d0cef73dSGregory Neil Shapiro<LI>xxfi_abort must reclaim any resources allocated on a per-message
5140266059SGregory Neil Shapirobasis, and must be tolerant of being called between any two
5240266059SGregory Neil Shapiromessage-oriented callbacks.
5340266059SGregory Neil Shapiro
54d0cef73dSGregory Neil Shapiro<LI>Calls to xxfi_abort and <A href="xxfi_eom.html">xxfi_eom</A> are
5540266059SGregory Neil Shapiromutually exclusive.
5640266059SGregory Neil Shapiro
57d0cef73dSGregory Neil Shapiro<LI>xxfi_abort is not responsible for reclaiming connection-specific
58d0cef73dSGregory Neil Shapirodata, since <A href="xxfi_close.html">xxfi_close</A> is always called
5940266059SGregory Neil Shapirowhen a connection is closed.
6040266059SGregory Neil Shapiro
61d0cef73dSGregory Neil Shapiro<LI>Since the current message is already being aborted, the return
6240266059SGregory Neil Shapirovalue is currently ignored.
6340266059SGregory Neil Shapiro
64d0cef73dSGregory Neil Shapiro<LI>xxfi_abort is only called if the message is aborted outside the
65d0cef73dSGregory Neil Shapirofilter's control <B>and</B> the filter has not completed its
6640266059SGregory Neil Shapiromessage-oriented processing.  For example, if a filter has already
6740266059SGregory Neil Shapiroreturned SMFIS_ACCEPT, SMFIS_REJECT, or SMFIS_DISCARD from a
6840266059SGregory Neil Shapiromessage-oriented routine, xxfi_abort will not be called even if the
6940266059SGregory Neil Shapiromessage is later aborted outside its control.
70d0cef73dSGregory Neil Shapiro</UL>
71d0cef73dSGregory Neil Shapiro</TD>
72d0cef73dSGregory Neil Shapiro</TR>
73d0cef73dSGregory Neil Shapiro</TABLE>
7440266059SGregory Neil Shapiro
75d0cef73dSGregory Neil Shapiro<HR size="1">
76d0cef73dSGregory Neil Shapiro<FONT size="-1">
775dd76dd0SGregory Neil ShapiroCopyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
7840266059SGregory Neil ShapiroAll rights reserved.
79d0cef73dSGregory Neil Shapiro<BR>
8040266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
815ef517c0SGregory Neil Shapiroforth in the LICENSE.
82d0cef73dSGregory Neil Shapiro</FONT>
83d0cef73dSGregory Neil Shapiro</BODY>
84d0cef73dSGregory Neil Shapiro</HTML>
85