xxfi_abort.html revision 168515 
1168515Sgshapiro<HTML>
2168515Sgshapiro<HEAD><TITLE>xxfi_abort</TITLE></HEAD>
3168515Sgshapiro<BODY>
4132943Sgshapiro<!--
5168515Sgshapiro$Id: xxfi_abort.html,v 1.12 2006/12/21 18:30:35 ca Exp $
6132943Sgshapiro-->
7168515Sgshapiro<H1>xxfi_abort</H1>
890792Sgshapiro
9168515Sgshapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1090792Sgshapiro<!---------- Synopsis ----------->
11168515Sgshapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12168515Sgshapiro<PRE>
1390792Sgshapiro#include &lt;libmilter/mfapi.h&gt;
1490792Sgshapirosfsistat (*xxfi_abort)(
15168515Sgshapiro	SMFICTX *ctx
1690792Sgshapiro);
17168515Sgshapiro</PRE>
1890792SgshapiroHandle the current message's being aborted.
19168515Sgshapiro</TD></TR>
2090792Sgshapiro
2190792Sgshapiro<!----------- Description ---------->
22168515Sgshapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
23168515Sgshapiro<TABLE border="1" cellspacing=1 cellpadding=4>
24168515Sgshapiro<TR align="left" valign=top>
25168515Sgshapiro<TH width="80">Called When</TH>
26168515Sgshapiro<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>
27168515Sgshapiro</TR>
28168515Sgshapiro<TR align="left" valign=top>
29168515Sgshapiro<TH>Default Behavior</TH>
30168515Sgshapiro<TD>Do nothing; return SMFIS_CONTINUE.</TD>
31168515Sgshapiro</TR>
32168515Sgshapiro</TABLE>
3390792Sgshapiro
3490792Sgshapiro<!----------- Arguments ---------->
35168515Sgshapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
36168515Sgshapiro    <TABLE border="1" cellspacing=0>
37168515Sgshapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
38168515Sgshapiro    <TR valign="top"><TD>ctx</TD>
39168515Sgshapiro	<TD>Opaque context structure.
40168515Sgshapiro	</TD></TR>
41168515Sgshapiro    </TABLE>
42168515Sgshapiro</TD></TR>
4390792Sgshapiro
4490792Sgshapiro<!----------- Notes ---------->
45168515Sgshapiro<TR>
46168515Sgshapiro<TH valign="top" align=left>NOTES</TH> 
47168515Sgshapiro<TD>
48168515Sgshapiro<UL>
49168515Sgshapiro<LI>xxfi_abort must reclaim any resources allocated on a per-message
5090792Sgshapirobasis, and must be tolerant of being called between any two
5190792Sgshapiromessage-oriented callbacks.
5290792Sgshapiro
53168515Sgshapiro<LI>Calls to xxfi_abort and <A href="xxfi_eom.html">xxfi_eom</A> are
5490792Sgshapiromutually exclusive.
5590792Sgshapiro
56168515Sgshapiro<LI>xxfi_abort is not responsible for reclaiming connection-specific
57168515Sgshapirodata, since <A href="xxfi_close.html">xxfi_close</A> is always called
5890792Sgshapirowhen a connection is closed.
5990792Sgshapiro
60168515Sgshapiro<LI>Since the current message is already being aborted, the return
6190792Sgshapirovalue is currently ignored.
6290792Sgshapiro
63168515Sgshapiro<LI>xxfi_abort is only called if the message is aborted outside the
64168515Sgshapirofilter's control <B>and</B> the filter has not completed its
6590792Sgshapiromessage-oriented processing.  For example, if a filter has already
6690792Sgshapiroreturned SMFIS_ACCEPT, SMFIS_REJECT, or SMFIS_DISCARD from a
6790792Sgshapiromessage-oriented routine, xxfi_abort will not be called even if the
6890792Sgshapiromessage is later aborted outside its control.
69168515Sgshapiro</UL>
70168515Sgshapiro</TD>
71168515Sgshapiro</TR>
72168515Sgshapiro</TABLE>
7390792Sgshapiro
74168515Sgshapiro<HR size="1">
75168515Sgshapiro<FONT size="-1">
76112810SgshapiroCopyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
7790792SgshapiroAll rights reserved.
78168515Sgshapiro<BR>
7990792SgshapiroBy using this file, you agree to the terms and conditions set
80112810Sgshapiroforth in the LICENSE.
81168515Sgshapiro</FONT>
82168515Sgshapiro</BODY>
83168515Sgshapiro</HTML>
84