contrib/sendmail-8.13.7/libmilter/docs/xxfi_close.html

   1 <html>
   2 <head><title>xxfi_close</title></head>
   3 <body>
   4 <!--
   5 $Id: xxfi_close.html,v 1.10 2004/06/16 22:41:36 ca Exp $
   6 -->
   7 <h1>xxfi_close</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_close)(
  15         SMFICTX * ctx
  16 );
  17 </pre>
  18 The current connection is being closed.
  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_close is always called once at the end of each connection.</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_close may be called "out-of-order", i.e. before even the
  50 xxfi_connect is called.
  51 After a connection is established by the MTA to the filter,
  52 if the MTA decides this connection's traffic will be discarded
  53 (e.g. via an access_db result), no data will be passed to the
  54 filter from the MTA until the client closes down.
  55 At that time, xxfi_close is called.
  56 It can therefore be the only callback ever used for a given connection,
  57 and developers should anticipate this possibility when crafting their
  58 xxfi_close code.
  59 In particular, it is incorrect to assume the private context pointer
  60 will be something other than NULL in this callback.
  61 <li>xxfi_close is called on close even if the previous mail
  62 transaction was aborted.
  63 <li>xxfi_close is responsible for freeing any resources allocated on a
  64 per-connection basis.
  65 <li>Since the connection is already closing, the return value is
  66 currently ignored.
  67 </ul>
  68 </td>
  69 </tr>
  70 </table>
  71
  72 <hr size="1">
  73 <font size="-1">
  74 Copyright (c) 2000, 2003, 2004 Sendmail, Inc. and its suppliers.
  75 All rights reserved.
  76 <br>
  77 By using this file, you agree to the terms and conditions set
  78 forth in the LICENSE.
  79 </font>
  80 </body>
  81 </html>