<!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: mw_srvc_store.h File 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><a href="classes.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>mw_srvc_store.h File Reference</h1>
<p>
<code>#include <glib.h></code><br>
<code>#include "<a class="el" href="mw__common_8h-source.html">mw_common.h</a>"</code><br>
<p>
<a href="mw__srvc__store_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#6befc88185dd58cc16e704e4c4c78322">KEY_IS_LOTUS_RESERVED</a>(key) (((guint32) key) <= (LOTUS_RESERVED_LIMIT))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a key is in the range of Lotus reserved keys. <a href="#6befc88185dd58cc16e704e4c4c78322"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#8bc869f420049a0bd5d0b1c2de7cc89e">LOTUS_RESERVED_LIMIT</a> 0x186a0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The upper limit of reserved Lotus keys. <a href="#8bc869f420049a0bd5d0b1c2de7cc89e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#25f65d69ffed33ef673c8e152106549b">mwService_STORAGE</a> 0x00000018</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type identifier for the storage service. <a href="#25f65d69ffed33ef673c8e152106549b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#5cebb99048ee65b6f3fd98c3eaf82021">mwStorageCallback</a> )(struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> *srvc, guint32 result, struct mwStorageUnit *item, gpointer data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appropriate function type for load and store callbacks. <a href="#5cebb99048ee65b6f3fd98c3eaf82021"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f88">mwStorageKey</a> { <br>
<a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f888f07f37098cbd1582954f3b060dd13ab">mwStore_AWARE_LIST</a> = 0x00000000,
<br>
<a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f8876cfbb82cc77f969260bf3ee1ab93950">mwStore_INVITE_CHAT</a> = 0x00000006,
<br>
<a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f88d97fb6917035f4ed4ca6576d8671b2d6">mwStore_INVITE_MEETING</a> = 0x0000000e,
<br>
<a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f888a037320a3eaff77120fee66eae5445b">mwStore_AWAY_MESSAGES</a> = 0x00000050,
<br>
<a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f882b1d1f0de29ac8b4f309bff5c58735f1">mwStore_BUSY_MESSAGES</a> = 0x0000005a,
<br>
<a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f88c3697e70cff492cbcbd2aca8fbc82f84">mwStore_ACTIVE_MESSAGES</a> = 0x00000064
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Some common keys storage keys. <a href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f88">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#8e323cfbdf1f9d3af18d7d27df3b603f">mwServiceStorage_load</a> (struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> *srvc, struct mwStorageUnit *item, <a class="el" href="mw__srvc__store_8h.html#5cebb99048ee65b6f3fd98c3eaf82021">mwStorageCallback</a> cb, gpointer data, GDestroyNotify data_free)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiates a load call to the storage service. <a href="#8e323cfbdf1f9d3af18d7d27df3b603f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#8f9571a1e27918cc057606600dd2cf25">mwServiceStorage_new</a> (struct <a class="el" href="structmwSession.html">mwSession</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates and initializes a storage service instance for use on the passed session. <a href="#8f9571a1e27918cc057606600dd2cf25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#43dafaf7dd5d09e4a1c92ec44bd5a842">mwServiceStorage_save</a> (struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> *srvc, struct mwStorageUnit *item, <a class="el" href="mw__srvc__store_8h.html#5cebb99048ee65b6f3fd98c3eaf82021">mwStorageCallback</a> cb, gpointer data, GDestroyNotify data_free)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiates a store call to the storage service. <a href="#43dafaf7dd5d09e4a1c92ec44bd5a842"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#f622a55188af247d9b15ba52fbc29e79">mwStorageUnit_asBoolean</a> (struct mwStorageUnit *, gboolean val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">attempts to obtain a boolean value from a storage unit. <a href="#f622a55188af247d9b15ba52fbc29e79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">guint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#34f62dceef1c6ea21b0561335c8a6abb">mwStorageUnit_asInteger</a> (struct mwStorageUnit *, guint32 val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">attempts to obtain a guint32 value from a storage unit. <a href="#34f62dceef1c6ea21b0561335c8a6abb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwOpaque.html">mwOpaque</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#c565c58bfa3b3a5094136abe38fbdaf6">mwStorageUnit_asOpaque</a> (struct mwStorageUnit *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">direct access to the opaque data backing the storage unit <a href="#c565c58bfa3b3a5094136abe38fbdaf6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#8c05a957993e34a0434052e3fced36b3">mwStorageUnit_asString</a> (struct mwStorageUnit *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">attempts to obtain a string value from a storage unit. <a href="#8c05a957993e34a0434052e3fced36b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#e9acfeda591578400ae5defcce84010c">mwStorageUnit_free</a> (struct mwStorageUnit *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clears and frees a storage unit <a href="#e9acfeda591578400ae5defcce84010c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">guint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#3bb73476fc749ff3a4e8ab0c327a83ba">mwStorageUnit_getKey</a> (struct mwStorageUnit *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the key for the given storage unit <a href="#3bb73476fc749ff3a4e8ab0c327a83ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct mwStorageUnit * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#319e221738360e4c784c2cb18df37f25">mwStorageUnit_new</a> (guint32 key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create an empty storage unit <a href="#319e221738360e4c784c2cb18df37f25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct mwStorageUnit * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#e2b9db3a516a5057949f7318eb32ab62">mwStorageUnit_newBoolean</a> (guint32 key, gboolean val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a storage unit with the passed key, and an encapsulated boolean value <a href="#e2b9db3a516a5057949f7318eb32ab62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct mwStorageUnit * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#3c11b0a807b72ff23a829a9f4bc26be8">mwStorageUnit_newInteger</a> (guint32 key, guint32 val)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct mwStorageUnit * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#0c11cfb40fc2a756241e3d8a642ef2c0">mwStorageUnit_newOpaque</a> (guint32 key, struct <a class="el" href="structmwOpaque.html">mwOpaque</a> *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a storage unit with the passed key, and a copy of data. <a href="#0c11cfb40fc2a756241e3d8a642ef2c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct mwStorageUnit * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__store_8h.html#97270b9020bd5185ad17a803fbf8f91a">mwStorageUnit_newString</a> (guint32 key, const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a storage unit with the passed key, and an encapsulated string value. <a href="#97270b9020bd5185ad17a803fbf8f91a"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="6befc88185dd58cc16e704e4c4c78322"></a><!-- doxytag: member="mw_srvc_store.h::KEY_IS_LOTUS_RESERVED" ref="6befc88185dd58cc16e704e4c4c78322" args="(key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_IS_LOTUS_RESERVED </td>
<td>(</td>
<td class="paramtype">key </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> (((guint32) key) <= (LOTUS_RESERVED_LIMIT))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a key is in the range of Lotus reserved keys.
<p>
</div>
</div><p>
<a class="anchor" name="8bc869f420049a0bd5d0b1c2de7cc89e"></a><!-- doxytag: member="mw_srvc_store.h::LOTUS_RESERVED_LIMIT" ref="8bc869f420049a0bd5d0b1c2de7cc89e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LOTUS_RESERVED_LIMIT 0x186a0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The upper limit of reserved Lotus keys.
<p>
</div>
</div><p>
<a class="anchor" name="25f65d69ffed33ef673c8e152106549b"></a><!-- doxytag: member="mw_srvc_store.h::mwService_STORAGE" ref="25f65d69ffed33ef673c8e152106549b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define mwService_STORAGE 0x00000018 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Type identifier for the storage service.
<p>
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="5cebb99048ee65b6f3fd98c3eaf82021"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageCallback" ref="5cebb99048ee65b6f3fd98c3eaf82021" args=")(struct mwServiceStorage *srvc, guint32 result, struct mwStorageUnit *item, gpointer data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="mw__srvc__store_8h.html#5cebb99048ee65b6f3fd98c3eaf82021">mwStorageCallback</a>)(struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> *srvc, guint32 result, struct mwStorageUnit *item, gpointer data) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Appropriate function type for load and store callbacks.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>srvc</em> </td><td>the storage service </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>the result value of the load or store call </td></tr>
<tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>the storage unit loaded or saved </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>optional user data </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="b490c5f87cc36273720570b9bb2b3f88"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageKey" ref="b490c5f87cc36273720570b9bb2b3f88" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="mw__srvc__store_8h.html#b490c5f87cc36273720570b9bb2b3f88">mwStorageKey</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Some common keys storage keys.
<p>
Anything in the range 0x00 to 0x186a0 (100000) is reserved for use by the Lotus clients. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="b490c5f87cc36273720570b9bb2b3f888f07f37098cbd1582954f3b060dd13ab"></a><!-- doxytag: member="mwStore_AWARE_LIST" ref="b490c5f87cc36273720570b9bb2b3f888f07f37098cbd1582954f3b060dd13ab" args="" -->mwStore_AWARE_LIST</em> </td><td>
The buddy list, in the Sametime .dat file format.
<p>
String </td></tr>
<tr><td valign="top"><em><a class="anchor" name="b490c5f87cc36273720570b9bb2b3f8876cfbb82cc77f969260bf3ee1ab93950"></a><!-- doxytag: member="mwStore_INVITE_CHAT" ref="b490c5f87cc36273720570b9bb2b3f8876cfbb82cc77f969260bf3ee1ab93950" args="" -->mwStore_INVITE_CHAT</em> </td><td>
Default text for chat invitations.
<p>
String </td></tr>
<tr><td valign="top"><em><a class="anchor" name="b490c5f87cc36273720570b9bb2b3f88d97fb6917035f4ed4ca6576d8671b2d6"></a><!-- doxytag: member="mwStore_INVITE_MEETING" ref="b490c5f87cc36273720570b9bb2b3f88d97fb6917035f4ed4ca6576d8671b2d6" args="" -->mwStore_INVITE_MEETING</em> </td><td>
Default text for meeting invitations.
<p>
String </td></tr>
<tr><td valign="top"><em><a class="anchor" name="b490c5f87cc36273720570b9bb2b3f888a037320a3eaff77120fee66eae5445b"></a><!-- doxytag: member="mwStore_AWAY_MESSAGES" ref="b490c5f87cc36273720570b9bb2b3f888a037320a3eaff77120fee66eae5445b" args="" -->mwStore_AWAY_MESSAGES</em> </td><td>
Last five Away messages, separated by semicolon.
<p>
String </td></tr>
<tr><td valign="top"><em><a class="anchor" name="b490c5f87cc36273720570b9bb2b3f882b1d1f0de29ac8b4f309bff5c58735f1"></a><!-- doxytag: member="mwStore_BUSY_MESSAGES" ref="b490c5f87cc36273720570b9bb2b3f882b1d1f0de29ac8b4f309bff5c58735f1" args="" -->mwStore_BUSY_MESSAGES</em> </td><td>
Last five Busy (DND) messages, separated by semicolon.
<p>
String </td></tr>
<tr><td valign="top"><em><a class="anchor" name="b490c5f87cc36273720570b9bb2b3f88c3697e70cff492cbcbd2aca8fbc82f84"></a><!-- doxytag: member="mwStore_ACTIVE_MESSAGES" ref="b490c5f87cc36273720570b9bb2b3f88c3697e70cff492cbcbd2aca8fbc82f84" args="" -->mwStore_ACTIVE_MESSAGES</em> </td><td>
Last five Active messages, separated by semicolon.
<p>
String </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="8e323cfbdf1f9d3af18d7d27df3b603f"></a><!-- doxytag: member="mw_srvc_store.h::mwServiceStorage_load" ref="8e323cfbdf1f9d3af18d7d27df3b603f" args="(struct mwServiceStorage *srvc, struct mwStorageUnit *item, mwStorageCallback cb, gpointer data, GDestroyNotify data_free)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mwServiceStorage_load </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> * </td>
<td class="paramname"> <em>srvc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname"> <em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mw__srvc__store_8h.html#5cebb99048ee65b6f3fd98c3eaf82021">mwStorageCallback</a> </td>
<td class="paramname"> <em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpointer </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GDestroyNotify </td>
<td class="paramname"> <em>data_free</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initiates a load call to the storage service.
<p>
If the service is not currently available, the call will be cached and processed when the service is started.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>srvc</em> </td><td>the storage service </td></tr>
<tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>storage unit to load </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cb</em> </td><td>callback function when the load call completes </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>user data for callback </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data_free</em> </td><td>optional cleanup function for user data </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8f9571a1e27918cc057606600dd2cf25"></a><!-- doxytag: member="mw_srvc_store.h::mwServiceStorage_new" ref="8f9571a1e27918cc057606600dd2cf25" args="(struct mwSession *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a>* mwServiceStorage_new </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmwSession.html">mwSession</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocates and initializes a storage service instance for use on the passed session.
<p>
</div>
</div><p>
<a class="anchor" name="43dafaf7dd5d09e4a1c92ec44bd5a842"></a><!-- doxytag: member="mw_srvc_store.h::mwServiceStorage_save" ref="43dafaf7dd5d09e4a1c92ec44bd5a842" args="(struct mwServiceStorage *srvc, struct mwStorageUnit *item, mwStorageCallback cb, gpointer data, GDestroyNotify data_free)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mwServiceStorage_save </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmwServiceStorage.html">mwServiceStorage</a> * </td>
<td class="paramname"> <em>srvc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname"> <em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mw__srvc__store_8h.html#5cebb99048ee65b6f3fd98c3eaf82021">mwStorageCallback</a> </td>
<td class="paramname"> <em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpointer </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GDestroyNotify </td>
<td class="paramname"> <em>data_free</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initiates a store call to the storage service.
<p>
If the service is not currently available, the call will be cached and processed when the service is started.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>srvc</em> </td><td>the storage service </td></tr>
<tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>storage unit to save </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cb</em> </td><td>callback function when the load call completes </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>optional user data for callback </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data_free</em> </td><td>optional cleanup function for user data </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f622a55188af247d9b15ba52fbc29e79"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_asBoolean" ref="f622a55188af247d9b15ba52fbc29e79" args="(struct mwStorageUnit *, gboolean val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean mwStorageUnit_asBoolean </td>
<td>(</td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
attempts to obtain a boolean value from a storage unit.
<p>
If the unit is empty, or does not contain the type in a recongnizable format, val is returned instead
</div>
</div><p>
<a class="anchor" name="34f62dceef1c6ea21b0561335c8a6abb"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_asInteger" ref="34f62dceef1c6ea21b0561335c8a6abb" args="(struct mwStorageUnit *, guint32 val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint32 mwStorageUnit_asInteger </td>
<td>(</td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
attempts to obtain a guint32 value from a storage unit.
<p>
If the unit is empty, or does not contain the type in a recognizable format, val is returned instead
</div>
</div><p>
<a class="anchor" name="c565c58bfa3b3a5094136abe38fbdaf6"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_asOpaque" ref="c565c58bfa3b3a5094136abe38fbdaf6" args="(struct mwStorageUnit *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmwOpaque.html">mwOpaque</a>* mwStorageUnit_asOpaque </td>
<td>(</td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
direct access to the opaque data backing the storage unit
<p>
</div>
</div><p>
<a class="anchor" name="8c05a957993e34a0434052e3fced36b3"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_asString" ref="8c05a957993e34a0434052e3fced36b3" args="(struct mwStorageUnit *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mwStorageUnit_asString </td>
<td>(</td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
attempts to obtain a string value from a storage unit.
<p>
If the unit is empty, or does not contain the type in a recognizable format, NULL is returned instead. Note that the string returned is a copy, and will need to be deallocated at some point.
</div>
</div><p>
<a class="anchor" name="e9acfeda591578400ae5defcce84010c"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_free" ref="e9acfeda591578400ae5defcce84010c" args="(struct mwStorageUnit *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mwStorageUnit_free </td>
<td>(</td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
clears and frees a storage unit
<p>
</div>
</div><p>
<a class="anchor" name="3bb73476fc749ff3a4e8ab0c327a83ba"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_getKey" ref="3bb73476fc749ff3a4e8ab0c327a83ba" args="(struct mwStorageUnit *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint32 mwStorageUnit_getKey </td>
<td>(</td>
<td class="paramtype">struct mwStorageUnit * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the key for the given storage unit
<p>
</div>
</div><p>
<a class="anchor" name="319e221738360e4c784c2cb18df37f25"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_new" ref="319e221738360e4c784c2cb18df37f25" args="(guint32 key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mwStorageUnit* mwStorageUnit_new </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create an empty storage unit
<p>
</div>
</div><p>
<a class="anchor" name="e2b9db3a516a5057949f7318eb32ab62"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_newBoolean" ref="e2b9db3a516a5057949f7318eb32ab62" args="(guint32 key, gboolean val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mwStorageUnit* mwStorageUnit_newBoolean </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
creates a storage unit with the passed key, and an encapsulated boolean value
<p>
</div>
</div><p>
<a class="anchor" name="3c11b0a807b72ff23a829a9f4bc26be8"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_newInteger" ref="3c11b0a807b72ff23a829a9f4bc26be8" args="(guint32 key, guint32 val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mwStorageUnit* mwStorageUnit_newInteger </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0c11cfb40fc2a756241e3d8a642ef2c0"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_newOpaque" ref="0c11cfb40fc2a756241e3d8a642ef2c0" args="(guint32 key, struct mwOpaque *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mwStorageUnit* mwStorageUnit_newOpaque </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structmwOpaque.html">mwOpaque</a> * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
creates a storage unit with the passed key, and a copy of data.
<p>
</div>
</div><p>
<a class="anchor" name="97270b9020bd5185ad17a803fbf8f91a"></a><!-- doxytag: member="mw_srvc_store.h::mwStorageUnit_newString" ref="97270b9020bd5185ad17a803fbf8f91a" args="(guint32 key, const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mwStorageUnit* mwStorageUnit_newString </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
creates a storage unit with the passed key, and an encapsulated string value.
<p>
</div>
</div><p>
<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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
d4a6745d7fbd92dfb64dce5e91e08f80
>
files
>
115
