<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>GNU CommonC++: ost::MapTable Class 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.4.6 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li id="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="examples.html"><span>Examples</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>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div> <div class="nav"> <a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_map_table.html">MapTable</a></div> <h1>ost::MapTable Class Reference</h1><!-- doxytag: class="ost::MapTable" --><!-- doxytag: inherits="ost::Mutex" -->A map table allows for entities to be mapped (hash index) onto it.Table to hold hash indexed objects. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="object_8h-source.html">object.h</a>></code> <p> <p>Inheritance diagram for ost::MapTable: <p><center><img src="classost_1_1_map_table.png" usemap="#ost::MapTable_map" border="0" alt=""></center> <map name="ost::MapTable_map"> <area href="classost_1_1_mutex.html" alt="ost::Mutex" shape="rect" coords="0,0,90,24"> </map> <a href="classost_1_1_map_table-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#5cb1baf9cbdcb47b429a07215d6f2131">MapTable</a> (unsigned size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a map table with a specified number of slots. <a href="#5cb1baf9cbdcb47b429a07215d6f2131"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#41b85b01b85eb7a6471b79685705fa29">~MapTable</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the table, calls cleanup. <a href="#41b85b01b85eb7a6471b79685705fa29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#07c9740944b2fd846fa23585b75e3d9d">getIndex</a> (const char *id)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get index value from id string. <a href="#07c9740944b2fd846fa23585b75e3d9d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#a8b1c538691c04ebe20bcbd37f93df6d">getRange</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return range of this table. <a href="#a8b1c538691c04ebe20bcbd37f93df6d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#1bdbde637f2fb0480b1ceb8ead4bccdb">getObject</a> (const char *id)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup an object by id key. <a href="#1bdbde637f2fb0480b1ceb8ead4bccdb"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#2ae4402514b29270220847071d2a40a6">addObject</a> (<a class="el" href="classost_1_1_map_object.html">MapObject</a> &obj)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Map an object to our table. <a href="#2ae4402514b29270220847071d2a40a6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#f2e352093e48831f567e3b0b91f4d9bb">getFree</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get next object from managed free list. <a href="#f2e352093e48831f567e3b0b91f4d9bb"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#e025e47a6545e0a2c5192de300924764">addFree</a> (<a class="el" href="classost_1_1_map_object.html">MapObject</a> *obj)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object to the managed free list. <a href="#e025e47a6545e0a2c5192de300924764"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_map_table.html">MapTable</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#5cade237b6cbe186b00ad50f6561443d">operator+=</a> (<a class="el" href="classost_1_1_map_object.html">MapObject</a> &obj)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An operator to map an object to the table. <a href="#5cade237b6cbe186b00ad50f6561443d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classost_1_1_map_table.html">MapTable</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#e6e0b700fc9cb734df0c301bbc36ab7f">operator-=</a> (<a class="el" href="classost_1_1_map_object.html">MapObject</a> &obj)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This operator is virtual in case it must also add the object to a managed free list. <a href="#e6e0b700fc9cb734df0c301bbc36ab7f"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#4603e784aa64184f4590b1b33eea6c60">cleanup</a> (void)</td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#e45620bcf37da41ab3089710e4dbfd32">range</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#a5ec0ac04b3d1b1d4e8af79f759bd87b">map</a></td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_table.html#d3a0f850a471fb5553eb77ee29b0af44">MapObject</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A map table allows for entities to be mapped (hash index) onto it.Table to hold hash indexed objects. <p> Unlike with <a class="el" href="classost_1_1_assoc.html">Assoc</a>, This form of map table also allows objects to be removed from the table. This table also includes a mutex lock for thread safety. A free list is also optionally maintained for reusable maps.<p> <dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="5cb1baf9cbdcb47b429a07215d6f2131"></a><!-- doxytag: member="ost::MapTable::MapTable" ref="5cb1baf9cbdcb47b429a07215d6f2131" args="(unsigned size)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">ost::MapTable::MapTable </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">unsigned </td> <td class="mdname1" valign="top" nowrap> <em>size</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Create a map table with a specified number of slots. <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>number</em> </td><td>of slots. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="41b85b01b85eb7a6471b79685705fa29"></a><!-- doxytag: member="ost::MapTable::~MapTable" ref="41b85b01b85eb7a6471b79685705fa29" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual ost::MapTable::~MapTable </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Destroy the table, calls cleanup. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e025e47a6545e0a2c5192de300924764"></a><!-- doxytag: member="ost::MapTable::addFree" ref="e025e47a6545e0a2c5192de300924764" args="(MapObject *obj)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MapTable::addFree </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a> * </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Add an object to the managed free list. <p> Some MapObject's may override delete operator to detach and do this.<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>object</em> </td><td>to add. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="2ae4402514b29270220847071d2a40a6"></a><!-- doxytag: member="ost::MapTable::addObject" ref="2ae4402514b29270220847071d2a40a6" args="(MapObject &obj)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MapTable::addObject </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a> & </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Map an object to our table. <p> If it is in another table already, it is removed there first.<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>object</em> </td><td>to map. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="4603e784aa64184f4590b1b33eea6c60"></a><!-- doxytag: member="ost::MapTable::cleanup" ref="4603e784aa64184f4590b1b33eea6c60" args="(void)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MapTable::cleanup </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [protected]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="f2e352093e48831f567e3b0b91f4d9bb"></a><!-- doxytag: member="ost::MapTable::getFree" ref="f2e352093e48831f567e3b0b91f4d9bb" args="(void)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void* ost::MapTable::getFree </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Get next object from managed free list. <p> This returns as a void so it can be recast into the actual type being used in derived MapObject's. A derived version of <a class="el" href="classost_1_1_map_table.html">MapTable</a> may well offer an explicit type version of this. Some derived MapObject's may override new to use managed list.<p> <dl compact><dt><b>Returns:</b></dt><dd>next object on free list. </dd></dl> </td> </tr> </table> <a class="anchor" name="07c9740944b2fd846fa23585b75e3d9d"></a><!-- doxytag: member="ost::MapTable::getIndex" ref="07c9740944b2fd846fa23585b75e3d9d" args="(const char *id)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual unsigned ost::MapTable::getIndex </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname1" valign="top" nowrap> <em>id</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Get index value from id string. <p> This function can be changed as needed to provide better collision avoidence for specific tables.<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>id</em> </td><td>string </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>index slot in table. </dd></dl> </td> </tr> </table> <a class="anchor" name="1bdbde637f2fb0480b1ceb8ead4bccdb"></a><!-- doxytag: member="ost::MapTable::getObject" ref="1bdbde637f2fb0480b1ceb8ead4bccdb" args="(const char *id)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void* ost::MapTable::getObject </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname1" valign="top" nowrap> <em>id</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Lookup an object by id key. <p> It is returned as void * for easy re-cast.<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>key</em> </td><td>to find. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>pointer to found object or NULL. </dd></dl> </td> </tr> </table> <a class="anchor" name="a8b1c538691c04ebe20bcbd37f93df6d"></a><!-- doxytag: member="ost::MapTable::getRange" ref="a8b1c538691c04ebe20bcbd37f93df6d" args="(void)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">unsigned ost::MapTable::getRange </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Return range of this table. <p> <dl compact><dt><b>Returns:</b></dt><dd>table range. </dd></dl> </td> </tr> </table> <a class="anchor" name="5cade237b6cbe186b00ad50f6561443d"></a><!-- doxytag: member="ost::MapTable::operator+=" ref="5cade237b6cbe186b00ad50f6561443d" args="(MapObject &obj)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_map_table.html">MapTable</a>& ost::MapTable::operator+= </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a> & </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> An operator to map an object to the table. <p> <dl compact><dt><b>Returns:</b></dt><dd>table being used. </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>being mapped. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="e6e0b700fc9cb734df0c301bbc36ab7f"></a><!-- doxytag: member="ost::MapTable::operator-=" ref="e6e0b700fc9cb734df0c301bbc36ab7f" args="(MapObject &obj)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual <a class="el" href="classost_1_1_map_table.html">MapTable</a>& ost::MapTable::operator-= </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a> & </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> This operator is virtual in case it must also add the object to a managed free list. <p> <dl compact><dt><b>Returns:</b></dt><dd>current table. </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>entity to remove. </td></tr> </table> </dl> </td> </tr> </table> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="d3a0f850a471fb5553eb77ee29b0af44"></a><!-- doxytag: member="ost::MapTable::MapObject" ref="d3a0f850a471fb5553eb77ee29b0af44" args="" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">friend class <a class="el" href="classost_1_1_map_object.html">MapObject</a><code> [friend]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="a5ec0ac04b3d1b1d4e8af79f759bd87b"></a><!-- doxytag: member="ost::MapTable::map" ref="a5ec0ac04b3d1b1d4e8af79f759bd87b" args="" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_map_object.html">MapObject</a>** <a class="el" href="classost_1_1_map_table.html#a5ec0ac04b3d1b1d4e8af79f759bd87b">ost::MapTable::map</a><code> [protected]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="e45620bcf37da41ab3089710e4dbfd32"></a><!-- doxytag: member="ost::MapTable::range" ref="e45620bcf37da41ab3089710e4dbfd32" args="" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">unsigned <a class="el" href="classost_1_1_map_table.html#e45620bcf37da41ab3089710e4dbfd32">ost::MapTable::range</a><code> [protected]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="object_8h-source.html">object.h</a></ul> <hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> </body> </html>