<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: ucommon::keyassoc Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00054.html">keyassoc</a>
</div>
</div>
<div class="contents">
<h1>ucommon::keyassoc Class Reference</h1><!-- doxytag: class="ucommon::keyassoc" --><!-- doxytag: inherits="ucommon::mempager" -->
<p>A class to hold memory pointers referenced by string names.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00190_source.html">memory.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::keyassoc:</div>
<div class="dynsection">
<div class="center"><img src="a00388.png" border="0" usemap="#ucommon_1_1keyassoc_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1keyassoc_inherit__map" id="ucommon_1_1keyassoc_inherit__map">
<area shape="rect" id="node9" href="a00017.html" title="A typed template for using a key association with typed objects." alt="" coords="5,304,387,331"/><area shape="rect" id="node2" href="a00081.html" title="A managed private heap for small allocations." alt="" coords="100,155,292,181"/><area shape="rect" id="node4" href="a00079.html" title="A memory protocol pager for private heap manager." alt="" coords="100,80,292,107"/><area shape="rect" id="node6" href="a00073.html" title="Common locking protocol." alt="" coords="65,5,327,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::keyassoc:</div>
<div class="dynsection">
<div class="center"><img src="a00389.png" border="0" usemap="#ucommon_1_1keyassoc_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1keyassoc_coll__map" id="ucommon_1_1keyassoc_coll__map">
<area shape="rect" id="node2" href="a00081.html" title="A managed private heap for small allocations." alt="" coords="40,267,232,293"/><area shape="rect" id="node4" href="a00079.html" title="A memory protocol pager for private heap manager." alt="" coords="40,176,232,203"/><area shape="rect" id="node6" href="a00073.html" title="Common locking protocol." alt="" coords="5,91,267,117"/><area shape="rect" id="node8" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="309,267,531,293"/><area shape="rect" id="node10" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="307,176,549,203"/><area shape="rect" id="node12" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="301,91,533,117"/><area shape="rect" id="node14" href="a00095.html" title="A common base class for all managed objects." alt="" coords="292,5,543,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a821edd47a6a49da2ea7c969ed7cf91e8">assign</a> (char *name, void *<a class="el" href="a00110.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a name to a data pointer. <a href="#a821edd47a6a49da2ea7c969ed7cf91e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a52a05d11c10c7513d9711b62244a07e2">create</a> (char *name, void *<a class="el" href="a00110.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new name in the association table and assign it's value. <a href="#a52a05d11c10c7513d9711b62244a07e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ae8284cc0e94e03f5fd335effd49cb3e0">getCount</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of associations we have in our object. <a href="#ae8284cc0e94e03f5fd335effd49cb3e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#aa773babb39a19755fcc37bb159fc401a">keyassoc</a> (unsigned indexing=177, size_t max=0, size_t page=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a key associated memory pointer table. <a href="#aa773babb39a19755fcc37bb159fc401a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#aea3a596142b2e9bf56a487d9b86a9c1c">locate</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup the data pointer by the string name given. <a href="#aea3a596142b2e9bf56a487d9b86a9c1c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#abf01feff7270f0e0c70341d53b1d47d2">operator()</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup the data pointer of a string by direct operation. <a href="#abf01feff7270f0e0c70341d53b1d47d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a605e07eefeff11c398a902db22b3770a"></a><!-- doxytag: member="ucommon::keyassoc::purge" ref="a605e07eefeff11c398a902db22b3770a" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a605e07eefeff11c398a902db22b3770a">purge</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purge all associations and return allocated pages to heap. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#acf457837ee879614a342b2a18b11c111">remove</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a name and pointer association. <a href="#acf457837ee879614a342b2a18b11c111"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ac8144b43729db213d7467d7df5153d01">~keyassoc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy association object. <a href="#ac8144b43729db213d7467d7df5153d01"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e7e87a5d5b6ec44dd83e7dd632dc7ca"></a><!-- doxytag: member="ucommon::keyassoc::keydata" ref="a7e7e87a5d5b6ec44dd83e7dd632dc7ca" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>keydata</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class to hold memory pointers referenced by string names. </p>
<p>This is used to form a typeless data pointer that can be associated and referenced by string/logical name. The memory used for forming the string names can itself be managed in reusable memory pools and the entire structure uses it's own private pager heap. This allows new string named pointers to be added and deleted at runtime in a thread- safe manner. This might typically be used as a session id manager or for symbol tables. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00431">431</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa773babb39a19755fcc37bb159fc401a"></a><!-- doxytag: member="ucommon::keyassoc::keyassoc" ref="aa773babb39a19755fcc37bb159fc401a" args="(unsigned indexing=177, size_t max=0, size_t page=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::keyassoc::keyassoc </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>indexing</em> = <code>177</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>max</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>page</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a key associated memory pointer table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>indexing</em> </td><td>size for hash map. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>size of a string name if names are in reusable managed memory. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>page</em> </td><td>size of memory pager. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac8144b43729db213d7467d7df5153d01"></a><!-- doxytag: member="ucommon::keyassoc::~keyassoc" ref="ac8144b43729db213d7467d7df5153d01" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::keyassoc::~keyassoc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy association object. </p>
<p>Release all pages back to the heap. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a821edd47a6a49da2ea7c969ed7cf91e8"></a><!-- doxytag: member="ucommon::keyassoc::assign" ref="a821edd47a6a49da2ea7c969ed7cf91e8" args="(char *name, void *pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::keyassoc::assign </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>pointer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign a name to a data pointer. </p>
<p>If the name exists, it is re-assigned with the new pointer value, otherwise it is created. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to assign. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>value to assign with name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if failed because name is too long for managed table. </dd></dl>
</div>
</div>
<a class="anchor" id="a52a05d11c10c7513d9711b62244a07e2"></a><!-- doxytag: member="ucommon::keyassoc::create" ref="a52a05d11c10c7513d9711b62244a07e2" args="(char *name, void *pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::keyassoc::create </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>pointer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new name in the association table and assign it's value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to create. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>value to assign with name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if already exists or name is too long for managed table. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8284cc0e94e03f5fd335effd49cb3e0"></a><!-- doxytag: member="ucommon::keyassoc::getCount" ref="ae8284cc0e94e03f5fd335effd49cb3e0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucommon::keyassoc::getCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of associations we have in our object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of associations stored. </dd></dl>
<p>Reimplemented in <a class="el" href="a00017.html#a874044a9b22a39502954dd97f4fb242c">ucommon::assoc_pointer< T, I, M, P ></a>.</p>
<p>Definition at line <a class="el" href="a00190_source.html#l00472">472</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="aea3a596142b2e9bf56a487d9b86a9c1c"></a><!-- doxytag: member="ucommon::keyassoc::locate" ref="aea3a596142b2e9bf56a487d9b86a9c1c" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ucommon::keyassoc::locate </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup the data pointer by the string name given. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to lookup. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to data or NULL if not found. </dd></dl>
<p>Reimplemented in <a class="el" href="a00017.html#af52f39b4a9aae6bd46f5282e05963fa1">ucommon::assoc_pointer< T, I, M, P ></a>.</p>
</div>
</div>
<a class="anchor" id="abf01feff7270f0e0c70341d53b1d47d2"></a><!-- doxytag: member="ucommon::keyassoc::operator()" ref="abf01feff7270f0e0c70341d53b1d47d2" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ucommon::keyassoc::operator() </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup the data pointer of a string by direct operation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to lookup. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to data or NULL if not found. </dd></dl>
<p>Reimplemented in <a class="el" href="a00017.html#a2ac22536d14c7c2c7366b603549fa6b0">ucommon::assoc_pointer< T, I, M, P ></a>.</p>
<p>Definition at line <a class="el" href="a00190_source.html#l00480">480</a> of file <a class="el" href="a00190_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="acf457837ee879614a342b2a18b11c111"></a><!-- doxytag: member="ucommon::keyassoc::remove" ref="acf457837ee879614a342b2a18b11c111" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ucommon::keyassoc::remove </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a name and pointer association. </p>
<p>If managed key names are used then the memory allocated for the name will be re-used. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer value of the name or NULL if not found. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00190_source.html">memory.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:36 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
116
