xxfi_abort.html revision 261363 
1<HTML>
2<HEAD><TITLE>xxfi_abort</TITLE></HEAD>
3<BODY>
4<!--
5$Id: xxfi_abort.html,v 1.13 2013/11/22 20:51:39 ca Exp $
6-->
7<H1>xxfi_abort</H1>
8
9<TABLE border="0" cellspacing=4 cellpadding=4>
10<!---------- Synopsis ----------->
11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12<PRE>
13#include &lt;libmilter/mfapi.h&gt;
14sfsistat (*xxfi_abort)(
15	SMFICTX *ctx
16);
17</PRE>
18Handle the current message's being aborted.
19</TD></TR>
20
21<!----------- Description ---------->
22<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
23<TABLE border="1" cellspacing=1 cellpadding=4>
24<TR align="left" valign=top>
25<TH width="80">Called When</TH>
26<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>
27</TR>
28<TR align="left" valign=top>
29<TH>Default Behavior</TH>
30<TD>Do nothing; return SMFIS_CONTINUE.</TD>
31</TR>
32</TABLE>
33
34<!----------- Arguments ---------->
35<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
36    <TABLE border="1" cellspacing=0>
37    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
38    <TR valign="top"><TD>ctx</TD>
39	<TD>Opaque context structure.
40	</TD></TR>
41    </TABLE>
42</TD></TR>
43
44<!----------- Notes ---------->
45<TR>
46<TH valign="top" align=left>NOTES</TH> 
47<TD>
48<UL>
49<LI>xxfi_abort must reclaim any resources allocated on a per-message
50basis, and must be tolerant of being called between any two
51message-oriented callbacks.
52
53<LI>Calls to xxfi_abort and <A href="xxfi_eom.html">xxfi_eom</A> are
54mutually exclusive.
55
56<LI>xxfi_abort is not responsible for reclaiming connection-specific
57data, since <A href="xxfi_close.html">xxfi_close</A> is always called
58when a connection is closed.
59
60<LI>Since the current message is already being aborted, the return
61value is currently ignored.
62
63<LI>xxfi_abort is only called if the message is aborted outside the
64filter's control <B>and</B> the filter has not completed its
65message-oriented processing.  For example, if a filter has already
66returned SMFIS_ACCEPT, SMFIS_REJECT, or SMFIS_DISCARD from a
67message-oriented routine, xxfi_abort will not be called even if the
68message is later aborted outside its control.
69</UL>
70</TD>
71</TR>
72</TABLE>
73
74<HR size="1">
75<FONT size="-1">
76Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
77All rights reserved.
78<BR>
79By using this file, you agree to the terms and conditions set
80forth in the LICENSE.
81</FONT>
82</BODY>
83</HTML>
84