<html>
<head><title>dkim_pstate</title></head>
<body>
<!--
$Id: dkim_pstate.html,v 1.2 2010/07/24 04:52:15 cm-msk Exp $
-->
<h1>DKIM_PSTATE</h1>
<p align="right"><a href="index.html">[back to index]</a></p>
<table border="0" cellspacing=4 cellpadding=4>
<!----------- 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">Purpose</th>
<td>A <tt>DKIM_PSTATE</tt> is an opaque structure which contains state
information with respect to policy lookups. <p>
DKIM policy evaluation is a multi-step process which can involve several
queries to look up SSP or other information about a sending domain. When
a policy lookup callback is in use
(see <tt><a href="dkim_set_policy_lookup.html">dkim_set_policy_lookup()</a></tt>),
the callback might be unable to complete a particular lookup and thus
return <tt>DKIM_CBSTAT_TRYAGAIN</tt>. In such cases, it is likely
desirable to resume the incomplete policy lookup when the calling
application knows it can complete the query. The <tt>DKIM_PSTATE</tt>
is a state structure which is loaded with information required to resume
a policy evaluation where a callback caused it to be suspended. <p>
Before use, it should be allocated by the caller and cleared using
<tt>bzero()</tt> or <tt>memset()</tt>.</td>
</tr>
</table>
<!----------- Notes ---------->
<tr>
<th valign="top" align=left>NOTES</th>
<td>
<ul>
<li>None.
</ul>
</td>
</tr>
</table>
<hr size="1">
<font size="-1">
Copyright (c) 2007 Sendmail, Inc. and its suppliers.
All rights reserved.
<br>
Copyright (c) 2009, 2010, The OpenDKIM Project. All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the respective licenses.
</font>
</body>
</html>
