contrib/sendmail-8.13.6/libmilter/docs/xxfi_abort.html

   1 <html>
   2 <head><title>xxfi_abort</title></head>
   3 <body>
   4 <!--
   5 $Id: xxfi_abort.html,v 1.9 2003/03/05 19:57:55 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=150>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
  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
  50 basis, and must be tolerant of being called between any two
  51 message-oriented callbacks.
  52
  53 <li>Calls to xxfi_abort and <a href="xxfi_eom.html">xxfi_eom</a> are
  54 mutually exclusive.
  55
  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.
  59
  60 <li>Since the current message is already being aborted, the return
  61 value is currently ignored.
  62
  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.
  69 </ul>
  70 </td>
  71 </tr>
  72 </table>
  73
  74 <hr size="1">
  75 <font size="-1">
  76 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  77 All rights reserved.
  78 <br>
  79 By using this file, you agree to the terms and conditions set
  80 forth in the LICENSE.
  81 </font>
  82 </body>
  83 </html>