NetBSD/gnu/dist/sendmail/libmilter/docs/xxfi_close.html

83 lines
2.4 KiB
HTML

<html>
<head><title>xxfi_close</title></head>
<body>
<!--
Id: xxfi_close.html,v 1.10 2004/06/16 22:41:36 ca Exp
$NetBSD: xxfi_close.html,v 1.1.1.3 2005/03/15 02:06:08 atatat Exp $
-->
<h1>xxfi_close</h1>
<table border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
<pre>
#include &lt;libmilter/mfapi.h&gt;
sfsistat (*xxfi_close)(
SMFICTX * ctx
);
</pre>
The current connection is being closed.
</td></tr>
<!----------- Description ---------->
<tr><th valign="top" align=left>DESCRIPTION</th><td>
<table border="1" cellspacing=1 cellpadding=4>
<tr align="left" valign=top>
<th width="80">Called When</th>
<td>xxfi_close is always called once at the end of each connection.</td>
</tr>
<tr align="left" valign=top>
<th>Default Behavior</th>
<td>Do nothing; return SMFIS_CONTINUE.</td>
</tr>
</table>
<!----------- Arguments ---------->
<tr><th valign="top" align=left>ARGUMENTS</th><td>
<table border="1" cellspacing=0>
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
<tr valign="top"><td>ctx</td>
<td>Opaque context structure.
</td></tr>
</table>
</td></tr>
<!----------- Notes ---------->
<tr>
<th valign="top" align=left>NOTES</th>
<td>
<ul>
<li>xxfi_close may be called "out-of-order", i.e. before even the
xxfi_connect is called.
After a connection is established by the MTA to the filter,
if the MTA decides this connection's traffic will be discarded
(e.g. via an access_db result), no data will be passed to the
filter from the MTA until the client closes down.
At that time, xxfi_close is called.
It can therefore be the only callback ever used for a given connection,
and developers should anticipate this possibility when crafting their
xxfi_close code.
In particular, it is incorrect to assume the private context pointer
will be something other than NULL in this callback.
<li>xxfi_close is called on close even if the previous mail
transaction was aborted.
<li>xxfi_close is responsible for freeing any resources allocated on a
per-connection basis.
<li>Since the connection is already closing, the return value is
currently ignored.
</ul>
</td>
</tr>
</table>
<hr size="1">
<font size="-1">
Copyright (c) 2000, 2003, 2004 Sendmail, Inc. and its suppliers.
All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
</font>
</body>
</html>