contrib/sendmail/libmilter/docs/xxfi_abort.html

   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;
  14 sfsistat (*xxfi_abort)(
  15         SMFICTX *ctx
  16 );
  17 </PRE>
  18 Handle 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 </TD></TR>
  34
  35 <!----------- Arguments ---------->
  36 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
  37     <TABLE border="1" cellspacing=0>
  38     <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
  39     <TR valign="top"><TD>ctx</TD>
  40         <TD>Opaque context structure.
  41         </TD></TR>
  42     </TABLE>
  43 </TD></TR>
  44
  45 <!----------- Notes ---------->
  46 <TR>
  47 <TH valign="top" align=left>NOTES</TH>
  48 <TD>
  49 <UL>
  50 <LI>xxfi_abort must reclaim any resources allocated on a per-message
  51 basis, and must be tolerant of being called between any two
  52 message-oriented callbacks.
  53
  54 <LI>Calls to xxfi_abort and <A href="xxfi_eom.html">xxfi_eom</A> are
  55 mutually exclusive.
  56
  57 <LI>xxfi_abort is not responsible for reclaiming connection-specific
  58 data, since <A href="xxfi_close.html">xxfi_close</A> is always called
  59 when a connection is closed.
  60
  61 <LI>Since the current message is already being aborted, the return
  62 value is currently ignored.
  63
  64 <LI>xxfi_abort is only called if the message is aborted outside the
  65 filter's control <B>and</B> the filter has not completed its
  66 message-oriented processing.  For example, if a filter has already
  67 returned SMFIS_ACCEPT, SMFIS_REJECT, or SMFIS_DISCARD from a
  68 message-oriented routine, xxfi_abort will not be called even if the
  69 message is later aborted outside its control.
  70 </UL>
  71 </TD>
  72 </TR>
  73 </TABLE>
  74
  75 <HR size="1">
  76 <FONT size="-1">
  77 Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
  78 All rights reserved.
  79 <BR>
  80 By using this file, you agree to the terms and conditions set
  81 forth in the LICENSE.
  82 </FONT>
  83 </BODY>
  84 </HTML>