2 <HEAD><TITLE>xxfi_abort</TITLE></HEAD>
5 $Id: xxfi_abort.html,v 1.13 2013/11/22 20:51:39 ca Exp $
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>
14 sfsistat (*xxfi_abort)(
18 Handle the current message's being aborted.
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>
28 <TR align="left" valign=top>
29 <TH>Default Behavior</TH>
30 <TD>Do nothing; return SMFIS_CONTINUE.</TD>
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.
44 <!----------- Notes ---------->
46 <TH valign="top" align=left>NOTES</TH>
49 <LI>xxfi_abort must reclaim any resources allocated on a per-message
50 basis, and must be tolerant of being called between any two
51 message-oriented callbacks.
53 <LI>Calls to xxfi_abort and <A href="xxfi_eom.html">xxfi_eom</A> are
56 <LI>xxfi_abort is not responsible for reclaiming connection-specific
57 data, since <A href="xxfi_close.html">xxfi_close</A> is always called
58 when a connection is closed.
60 <LI>Since the current message is already being aborted, the return
61 value is currently ignored.
63 <LI>xxfi_abort is only called if the message is aborted outside the
64 filter's control <B>and</B> the filter has not completed its
65 message-oriented processing. For example, if a filter has already
66 returned SMFIS_ACCEPT, SMFIS_REJECT, or SMFIS_DISCARD from a
67 message-oriented routine, xxfi_abort will not be called even if the
68 message is later aborted outside its control.
76 Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
79 By using this file, you agree to the terms and conditions set