<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>meanwhile: mwCipher Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<h1>mwCipher Struct Reference</h1><!-- doxytag: class="mwCipher" --><code>#include <<a class="el" href="mw__cipher_8h-source.html">mw_cipher.h</a>></code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A cipher.
<p>
Ciphers are primarily used to provide cipher instances for bi-directional encryption on channels, but some may be used for other activities. Expand upon this structure to create a custom encryption provider. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structmwCipherInstance.html" title="An instance of a cipher.">mwCipherInstance</a> </dd></dl>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#3757d769480279c6af691587fcadad75">accept</a> )(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#ae223ec72cfa4f9fc0fea723609edfff">accepted</a> )(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci, struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a> *item)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#2759a966db6c87ccbc7a30351d04b52c">clear</a> )(struct <a class="el" href="structmwCipher.html">mwCipher</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">prepare this cipher for being free'd <a href="#2759a966db6c87ccbc7a30351d04b52c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#c15dbe512f0e1b1c24923f39596022fa">clear_instance</a> )(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clean up a cipher instance before being free'd <a href="#c15dbe512f0e1b1c24923f39596022fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="mw__cipher_8h.html#130909e22689a8b83c70572af9850bef">mwCipherProcessor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#9dff138daf0f325e897dea90e70078b6">decrypt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#20e64408792db9e2845f8a7865eefe65" title="decrypt data">mwCipherInstance_decrypt</a> </dd></dl>
<a href="#9dff138daf0f325e897dea90e70078b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="mw__cipher_8h.html#130909e22689a8b83c70572af9850bef">mwCipherProcessor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#c3fa2b1a18b7924450bc5343624b8a2a">encrypt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#fbdb09cd3991970596b9e7ad1865a4b5" title="encrypt data">mwCipherInstance_encrypt</a> </dd></dl>
<a href="#c3fa2b1a18b7924450bc5343624b8a2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#f38ccab055e6734cb038d1bb657c5c12">get_desc</a> )()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#2fe3c59366be8e33dea3ea8089f17309">mwCipher_getDesc</a> </dd></dl>
<a href="#f38ccab055e6734cb038d1bb657c5c12"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#92ce6896b01d174b19952029c7054f7f">get_name</a> )()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#57a44521a627c04f67fd26b6112c232e">mwCipher_getName</a> </dd></dl>
<a href="#92ce6896b01d174b19952029c7054f7f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="mw__cipher_8h.html#866fc29431a5cd1c3c49e9b1e8b09800">mwCipherInstantiator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#dfed31e997b9a9ba78363fdb1476253b">new_instance</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generate a new Cipher Instance for use on a channel. <a href="#dfed31e997b9a9ba78363fdb1476253b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#fd415bbd997d28f62c120f921d2149cd">offer</a> )(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#e47e505d184f4d6ea6a2762f76aba9e4">offered</a> )(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci, struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a> *item)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwSession.html">mwSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#ec395dce47a0b5f4779522bd0c1888e2">session</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">service this cipher is providing for <a href="#ec395dce47a0b5f4779522bd0c1888e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">guint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwCipher.html#a65d8c035878ffd68aa21099a18eb959">type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#9c78471afd459b09ddf5e544d9a07f56">mwCipher_getType</a> </dd></dl>
<a href="#a65d8c035878ffd68aa21099a18eb959"></a><br></td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="3757d769480279c6af691587fcadad75"></a><!-- doxytag: member="mwCipher::accept" ref="3757d769480279c6af691587fcadad75" args=")(struct mwCipherInstance *ci)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a>*(* <a class="el" href="structmwCipher.html#3757d769480279c6af691587fcadad75">mwCipher::accept</a>)(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci)<code> [read]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ae223ec72cfa4f9fc0fea723609edfff"></a><!-- doxytag: member="mwCipher::accepted" ref="ae223ec72cfa4f9fc0fea723609edfff" args=")(struct mwCipherInstance *ci, struct mwEncryptItem *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structmwCipher.html#ae223ec72cfa4f9fc0fea723609edfff">mwCipher::accepted</a>)(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci, struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a> *item) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2759a966db6c87ccbc7a30351d04b52c"></a><!-- doxytag: member="mwCipher::clear" ref="2759a966db6c87ccbc7a30351d04b52c" args=")(struct mwCipher *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structmwCipher.html#2759a966db6c87ccbc7a30351d04b52c">mwCipher::clear</a>)(struct <a class="el" href="structmwCipher.html">mwCipher</a> *c) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
prepare this cipher for being free'd
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#4d6a169e214b8e6b60e6fb2e7c5c51bd" title="destroy a cipher">mwCipher_free</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="c15dbe512f0e1b1c24923f39596022fa"></a><!-- doxytag: member="mwCipher::clear_instance" ref="c15dbe512f0e1b1c24923f39596022fa" args=")(struct mwCipherInstance *ci)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structmwCipher.html#c15dbe512f0e1b1c24923f39596022fa">mwCipher::clear_instance</a>)(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
clean up a cipher instance before being free'd
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#302cdec8d916252920962bc7aefe39a4" title="destroy a cipher instance">mwCipherInstance_free</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9dff138daf0f325e897dea90e70078b6"></a><!-- doxytag: member="mwCipher::decrypt" ref="9dff138daf0f325e897dea90e70078b6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mw__cipher_8h.html#130909e22689a8b83c70572af9850bef">mwCipherProcessor</a> <a class="el" href="structmwCipher.html#9dff138daf0f325e897dea90e70078b6">mwCipher::decrypt</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#20e64408792db9e2845f8a7865eefe65" title="decrypt data">mwCipherInstance_decrypt</a> </dd></dl>
<p>
</div>
</div><p>
<a class="anchor" name="c3fa2b1a18b7924450bc5343624b8a2a"></a><!-- doxytag: member="mwCipher::encrypt" ref="c3fa2b1a18b7924450bc5343624b8a2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mw__cipher_8h.html#130909e22689a8b83c70572af9850bef">mwCipherProcessor</a> <a class="el" href="structmwCipher.html#c3fa2b1a18b7924450bc5343624b8a2a">mwCipher::encrypt</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#fbdb09cd3991970596b9e7ad1865a4b5" title="encrypt data">mwCipherInstance_encrypt</a> </dd></dl>
<p>
</div>
</div><p>
<a class="anchor" name="f38ccab055e6734cb038d1bb657c5c12"></a><!-- doxytag: member="mwCipher::get_desc" ref="f38ccab055e6734cb038d1bb657c5c12" args=")()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char*(* <a class="el" href="structmwCipher.html#f38ccab055e6734cb038d1bb657c5c12">mwCipher::get_desc</a>)() </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#2fe3c59366be8e33dea3ea8089f17309">mwCipher_getDesc</a> </dd></dl>
<p>
</div>
</div><p>
<a class="anchor" name="92ce6896b01d174b19952029c7054f7f"></a><!-- doxytag: member="mwCipher::get_name" ref="92ce6896b01d174b19952029c7054f7f" args=")()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char*(* <a class="el" href="structmwCipher.html#92ce6896b01d174b19952029c7054f7f">mwCipher::get_name</a>)() </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#57a44521a627c04f67fd26b6112c232e">mwCipher_getName</a> </dd></dl>
<p>
</div>
</div><p>
<a class="anchor" name="dfed31e997b9a9ba78363fdb1476253b"></a><!-- doxytag: member="mwCipher::new_instance" ref="dfed31e997b9a9ba78363fdb1476253b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mw__cipher_8h.html#866fc29431a5cd1c3c49e9b1e8b09800">mwCipherInstantiator</a> <a class="el" href="structmwCipher.html#dfed31e997b9a9ba78363fdb1476253b">mwCipher::new_instance</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generate a new Cipher Instance for use on a channel.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#0d03f56fb313094c1129a4e8086cfce3">mwCipher_newInstance</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="fd415bbd997d28f62c120f921d2149cd"></a><!-- doxytag: member="mwCipher::offer" ref="fd415bbd997d28f62c120f921d2149cd" args=")(struct mwCipherInstance *ci)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a>*(* <a class="el" href="structmwCipher.html#fd415bbd997d28f62c120f921d2149cd">mwCipher::offer</a>)(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci)<code> [read]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e47e505d184f4d6ea6a2762f76aba9e4"></a><!-- doxytag: member="mwCipher::offered" ref="e47e505d184f4d6ea6a2762f76aba9e4" args=")(struct mwCipherInstance *ci, struct mwEncryptItem *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structmwCipher.html#e47e505d184f4d6ea6a2762f76aba9e4">mwCipher::offered</a>)(struct <a class="el" href="structmwCipherInstance.html">mwCipherInstance</a> *ci, struct <a class="el" href="structmwEncryptItem.html">mwEncryptItem</a> *item) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ec395dce47a0b5f4779522bd0c1888e2"></a><!-- doxytag: member="mwCipher::session" ref="ec395dce47a0b5f4779522bd0c1888e2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmwSession.html">mwSession</a>* <a class="el" href="structmwCipher.html#ec395dce47a0b5f4779522bd0c1888e2">mwCipher::session</a><code> [read]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
service this cipher is providing for
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#ca7df61aefa4a1eda2776c9d11d66c04">mwCipher_getSession</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="a65d8c035878ffd68aa21099a18eb959"></a><!-- doxytag: member="mwCipher::type" ref="a65d8c035878ffd68aa21099a18eb959" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint16 <a class="el" href="structmwCipher.html#a65d8c035878ffd68aa21099a18eb959">mwCipher::type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__cipher_8h.html#9c78471afd459b09ddf5e544d9a07f56">mwCipher_getType</a> </dd></dl>
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mw__cipher_8h-source.html">mw_cipher.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 09:10:34 2007 for meanwhile by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
