82 lines
2.3 KiB
HTML
82 lines
2.3 KiB
HTML
<HTML>
|
|
<HEAD><TITLE>xxfi_close</TITLE></HEAD>
|
|
<BODY>
|
|
<!--
|
|
$Id: xxfi_close.html,v 1.14 2013-11-22 20:51:39 ca Exp $
|
|
-->
|
|
<H1>xxfi_close</H1>
|
|
|
|
<TABLE border="0" cellspacing=4 cellpadding=4>
|
|
<!---------- Synopsis ----------->
|
|
<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
|
|
<PRE>
|
|
#include <libmilter/mfapi.h>
|
|
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 Proofpoint, 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>
|