diff options
Diffstat (limited to 'build/doc/html/structpw__map.html')
| -rw-r--r-- | build/doc/html/structpw__map.html | 536 |
1 files changed, 536 insertions, 0 deletions
diff --git a/build/doc/html/structpw__map.html b/build/doc/html/structpw__map.html new file mode 100644 index 00000000..47c9cd40 --- /dev/null +++ b/build/doc/html/structpw__map.html @@ -0,0 +1,536 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.15"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>PipeWire: pw_map Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(initResizable); +/* @license-end */</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">PipeWire +  <span id="projectnumber">0.2.9</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.15 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('structpw__map.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">pw_map Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A map. + <a href="structpw__map.html#details">More...</a></p> +<div class="dynheader"> +Collaboration diagram for pw_map:</div> +<div class="dyncontent"> +<div class="center"><img src="structpw__map__coll__graph.png" border="0" usemap="#pw__map_coll__map" alt="Collaboration graph"/></div> +<map name="pw__map_coll__map" id="pw__map_coll__map"> +<area shape="rect" title="A map." alt="" coords="8,95,85,121"/> +<area shape="rect" href="structpw__array.html" title="An array object." alt="" coords="5,5,88,32"/> +</map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a3e84b47d125ced3009966a174bb256fa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a3e84b47d125ced3009966a174bb256fa">PW_MAP_ID_TO_PTR</a>(id)   (SPA_UINT32_TO_PTR((id)<<1))</td></tr> +<tr class="memdesc:a3e84b47d125ced3009966a174bb256fa"><td class="mdescLeft"> </td><td class="mdescRight">Convert an id to a pointer that can be inserted into the map. <a href="#a3e84b47d125ced3009966a174bb256fa">More...</a><br /></td></tr> +<tr class="separator:a3e84b47d125ced3009966a174bb256fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91899b8a60f9dddea1580fd68aa1ae5f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a91899b8a60f9dddea1580fd68aa1ae5f">PW_MAP_PTR_TO_ID</a>(p)   (SPA_PTR_TO_UINT32(p)>>1)</td></tr> +<tr class="memdesc:a91899b8a60f9dddea1580fd68aa1ae5f"><td class="mdescLeft"> </td><td class="mdescRight">Convert a pointer to an id that can be retrieved from the map. <a href="#a91899b8a60f9dddea1580fd68aa1ae5f">More...</a><br /></td></tr> +<tr class="separator:a91899b8a60f9dddea1580fd68aa1ae5f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acdd13c22e79cecf19a28d30e1154d323"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#acdd13c22e79cecf19a28d30e1154d323">pw_map_init</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map, size_t size, size_t extend)</td></tr> +<tr class="memdesc:acdd13c22e79cecf19a28d30e1154d323"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a map. <a href="#acdd13c22e79cecf19a28d30e1154d323">More...</a><br /></td></tr> +<tr class="separator:acdd13c22e79cecf19a28d30e1154d323"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a962f1ba02a79802e16088c4ae8174804"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a962f1ba02a79802e16088c4ae8174804">pw_map_clear</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map)</td></tr> +<tr class="memdesc:a962f1ba02a79802e16088c4ae8174804"><td class="mdescLeft"> </td><td class="mdescRight">Clear a map. <a href="#a962f1ba02a79802e16088c4ae8174804">More...</a><br /></td></tr> +<tr class="separator:a962f1ba02a79802e16088c4ae8174804"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a39efc6ce617c07d672b287945cf7a46b"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a39efc6ce617c07d672b287945cf7a46b">pw_map_insert_new</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a39efc6ce617c07d672b287945cf7a46b"><td class="mdescLeft"> </td><td class="mdescRight">Insert data in the map. <a href="#a39efc6ce617c07d672b287945cf7a46b">More...</a><br /></td></tr> +<tr class="separator:a39efc6ce617c07d672b287945cf7a46b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a10124711c6ab6ad3c1b9e6cab49dc4e4"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a10124711c6ab6ad3c1b9e6cab49dc4e4">pw_map_insert_at</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map, uint32_t id, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a10124711c6ab6ad3c1b9e6cab49dc4e4"><td class="mdescLeft"> </td><td class="mdescRight">Insert data in the map at an index. <a href="#a10124711c6ab6ad3c1b9e6cab49dc4e4">More...</a><br /></td></tr> +<tr class="separator:a10124711c6ab6ad3c1b9e6cab49dc4e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a07ee8a656f7e1ffbc10cb343b4881a86"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a07ee8a656f7e1ffbc10cb343b4881a86">pw_map_remove</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map, uint32_t id)</td></tr> +<tr class="memdesc:a07ee8a656f7e1ffbc10cb343b4881a86"><td class="mdescLeft"> </td><td class="mdescRight">Remove an item at index. <a href="#a07ee8a656f7e1ffbc10cb343b4881a86">More...</a><br /></td></tr> +<tr class="separator:a07ee8a656f7e1ffbc10cb343b4881a86"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9656703501cdaa5a82adb9db60f76fc6"><td class="memItemLeft" align="right" valign="top">static void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a9656703501cdaa5a82adb9db60f76fc6">pw_map_lookup</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map, uint32_t id)</td></tr> +<tr class="memdesc:a9656703501cdaa5a82adb9db60f76fc6"><td class="mdescLeft"> </td><td class="mdescRight">Find an item in the map. <a href="#a9656703501cdaa5a82adb9db60f76fc6">More...</a><br /></td></tr> +<tr class="separator:a9656703501cdaa5a82adb9db60f76fc6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adcd4d2843a41d2f0d70bfd80790a9518"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#adcd4d2843a41d2f0d70bfd80790a9518">pw_map_for_each</a> (struct <a class="el" href="structpw__map.html">pw_map</a> *map, int(*func)(void *item_data, void *<a class="el" href="structdata.html">data</a>), void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:adcd4d2843a41d2f0d70bfd80790a9518"><td class="mdescLeft"> </td><td class="mdescRight">Iterate all map items. <a href="#adcd4d2843a41d2f0d70bfd80790a9518">More...</a><br /></td></tr> +<tr class="separator:adcd4d2843a41d2f0d70bfd80790a9518"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:a6fc621171dbc57de8c44d26f639d2f1b"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__array.html">pw_array</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#a6fc621171dbc57de8c44d26f639d2f1b">items</a></td></tr> +<tr class="memdesc:a6fc621171dbc57de8c44d26f639d2f1b"><td class="mdescLeft"> </td><td class="mdescRight">an array with the map items <a href="#a6fc621171dbc57de8c44d26f639d2f1b">More...</a><br /></td></tr> +<tr class="separator:a6fc621171dbc57de8c44d26f639d2f1b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acf2ad4417afa20b00e4a1f3837573d87"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__map.html#acf2ad4417afa20b00e4a1f3837573d87">free_list</a></td></tr> +<tr class="memdesc:acf2ad4417afa20b00e4a1f3837573d87"><td class="mdescLeft"> </td><td class="mdescRight">the free items <a href="#acf2ad4417afa20b00e4a1f3837573d87">More...</a><br /></td></tr> +<tr class="separator:acf2ad4417afa20b00e4a1f3837573d87"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A map. </p> +<p>A map that holds objects indexed by id.</p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a962f1ba02a79802e16088c4ae8174804"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a962f1ba02a79802e16088c4ae8174804">◆ </a></span>pw_map_clear()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static void pw_map_clear </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Clear a map. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to clear </td></tr> + </table> + </dd> +</dl> + +<p class="reference">Referenced by <a class="el" href="remote_8c.html#a0e927d9eff1cc1a6ae723617e4f4abec">pw_remote_destroy()</a>.</p> + +</div> +</div> +<a id="adcd4d2843a41d2f0d70bfd80790a9518"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adcd4d2843a41d2f0d70bfd80790a9518">◆ </a></span>pw_map_for_each()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int pw_map_for_each </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int(*)(void *item_data, void *<a class="el" href="structdata.html">data</a>) </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Iterate all map items. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to iterate </td></tr> + <tr><td class="paramname">func</td><td>the function to call for each item, the item data and <em>data</em> is passed to the function. When <em>func</em> returns a non-zero result, iteration ends and the result is returned. </td></tr> + <tr><td class="paramname">data</td><td>data to pass to <em>func</em> </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the result of the last call to <em>func</em> or 0 when all callbacks returned 0. </dd></dl> + +<p class="reference">References <a class="el" href="unionpw__map__item.html#a5ab66a0f62ff9e5b8d6192f980658d38">pw_map_item::data</a>, <a class="el" href="structpw__map.html#a6fc621171dbc57de8c44d26f639d2f1b">items</a>, <a class="el" href="array_8h.html#aa960ca693013e1b7fce13b0968db70b8">pw_array_for_each</a>, and <a class="el" href="map_8h.html#abbbe18fa2f93752c95f83ccac5a8e9a6">pw_map_item_is_free</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__client.html#a1240f3b1d2d8d0dcc712bfeca8aff185">pw_client::pw_client_destroy()</a>.</p> + +</div> +</div> +<a id="acdd13c22e79cecf19a28d30e1154d323"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acdd13c22e79cecf19a28d30e1154d323">◆ </a></span>pw_map_init()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static void pw_map_init </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>extend</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Initialize a map. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to initialize </td></tr> + <tr><td class="paramname">size</td><td>the initial size of the map </td></tr> + <tr><td class="paramname">extend</td><td>the amount to bytes to grow the map with when needed </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="structpw__array.html#a92ae2df32c3d6935897f41b6e7f5ad3c">pw_array::extend</a>, <a class="el" href="structpw__map.html#acf2ad4417afa20b00e4a1f3837573d87">free_list</a>, <a class="el" href="structpw__map.html#a6fc621171dbc57de8c44d26f639d2f1b">items</a>, <a class="el" href="structpw__array.html#a3045d41af637079f6cba71102050f119">pw_array::pw_array_ensure_size()</a>, <a class="el" href="structpw__array.html#a41905dd179bcee03cceef47579e0a22e">pw_array::pw_array_init()</a>, and <a class="el" href="structpw__array.html#a3d468425a1a0084f98301e2fd9becc6b">pw_array::size</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="mem_8c.html#ae5e42242439fef39fd696db151642513">pw_mempool_new()</a>, and <a class="el" href="remote_8c.html#ab4d94be2412050ec56ad495ccf75f9b3">pw_remote_new()</a>.</p> + +</div> +</div> +<a id="a10124711c6ab6ad3c1b9e6cab49dc4e4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a10124711c6ab6ad3c1b9e6cab49dc4e4">◆ </a></span>pw_map_insert_at()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int pw_map_insert_at </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Insert data in the map at an index. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to inser into </td></tr> + <tr><td class="paramname">id</td><td>the index to insert at </td></tr> + <tr><td class="paramname">data</td><td>the data to insert </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success, -ENOSPC value when the index is invalid or a < 0 errno value. </dd></dl> + +<p class="reference">References <a class="el" href="unionpw__map__item.html#a5ab66a0f62ff9e5b8d6192f980658d38">pw_map_item::data</a>, <a class="el" href="structpw__map.html#a6fc621171dbc57de8c44d26f639d2f1b">items</a>, <a class="el" href="structpw__array.html#adf6a4fd9f9bd810eb374737b3d1169b2">pw_array::pw_array_add()</a>, <a class="el" href="map_8h.html#ae4711748f39e5e8235faf961f35fb8a2">pw_map_get_item</a>, and <a class="el" href="map_8h.html#a2ef0d619ea803c94409128752bb89763">pw_map_get_size</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__global.html#af71bfe154978f67a599df1aec2ade802">pw_global::pw_global_bind()</a>, <a class="el" href="port_8c.html#a76fda7098a866ae2a145e156a6ae2cf8">pw_port_add()</a>, <a class="el" href="classpw__proxy.html#a14ac10c78b59690235afab18ea1c906e">pw_proxy::pw_proxy_destroy()</a>, <a class="el" href="resource_8c.html#a77aff410edb984bf14e2d2787c567480">pw_resource_destroy()</a>, and <a class="el" href="resource_8c.html#a13bc34ff7eecd313331ff6d95e8c95a5">pw_resource_new()</a>.</p> + +</div> +</div> +<a id="a39efc6ce617c07d672b287945cf7a46b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a39efc6ce617c07d672b287945cf7a46b">◆ </a></span>pw_map_insert_new()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static uint32_t pw_map_insert_new </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Insert data in the map. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to insert into </td></tr> + <tr><td class="paramname">data</td><td>the item to add </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the id where the item was inserted or SPA_ID_INVALID when the item can not be inserted. </dd></dl> + +<p class="reference">References <a class="el" href="structpw__array.html#ab0929cdf2f7acb291f2f17be299b8ea5">pw_array::data</a>, <a class="el" href="unionpw__map__item.html#a5ab66a0f62ff9e5b8d6192f980658d38">pw_map_item::data</a>, <a class="el" href="structpw__map.html#acf2ad4417afa20b00e4a1f3837573d87">free_list</a>, <a class="el" href="structpw__map.html#a6fc621171dbc57de8c44d26f639d2f1b">items</a>, <a class="el" href="unionpw__map__item.html#a51685fc6de470af5d8a477bc98de5bb2">pw_map_item::next</a>, and <a class="el" href="structpw__array.html#adf6a4fd9f9bd810eb374737b3d1169b2">pw_array::pw_array_add()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__global.html#a70cf2ad61f1f9b7c1cb40a1ea6e73ce5">pw_global::pw_global_new()</a>, <a class="el" href="structpw__memblock.html#a2e25b63057f2c8159c9ad7eba16555db">pw_memblock::pw_mempool_alloc()</a>, <a class="el" href="node_8c.html#a120175714bc1c60ca330a4354d7c288e">pw_node_get_free_port_id()</a>, <a class="el" href="port_8c.html#a31462bdc128e47a2dc6ebef487df9b62">pw_port_init_mix()</a>, and <a class="el" href="classpw__proxy.html#a7c06847bc4258d7a603f9bd507309226">pw_proxy::pw_proxy_new()</a>.</p> + +</div> +</div> +<a id="a9656703501cdaa5a82adb9db60f76fc6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9656703501cdaa5a82adb9db60f76fc6">◆ </a></span>pw_map_lookup()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static void * pw_map_lookup </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Find an item in the map. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to use </td></tr> + <tr><td class="paramname">id</td><td>the index to look at </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the item at <em>id</em> or NULL when no such item exists </dd></dl> + +<p class="reference">References <a class="el" href="unionpw__map__item.html#a5ab66a0f62ff9e5b8d6192f980658d38">pw_map_item::data</a>, <a class="el" href="map_8h.html#a0b288cc2632c67d0ea9f6891baf3ab54">pw_map_check_id</a>, <a class="el" href="map_8h.html#ae4711748f39e5e8235faf961f35fb8a2">pw_map_get_item</a>, and <a class="el" href="map_8h.html#abbbe18fa2f93752c95f83ccac5a8e9a6">pw_map_item_is_free</a>.</p> + +<p class="reference">Referenced by <a class="el" href="client_8c.html#a075f521e79ad083ffeca6ce6fd0d50a6">pw_client_find_resource()</a>, <a class="el" href="core_8c.html#a10a751bf1c704728191d9a7c31a63172">pw_core_find_global()</a>, <a class="el" href="mem_8c.html#a277a61f49a8c8e232bb3af723af1fb3f">pw_mempool_find_id()</a>, <a class="el" href="mem_8c.html#a7066384a72de880e75a1b922d2d62dd2">pw_mempool_map_id()</a>, <a class="el" href="mem_8c.html#a5f75d7faa910a02718a9ecf3f9c4041c">pw_mempool_unref_id()</a>, <a class="el" href="node_8c.html#abcd651256965089972ad5a23f81564fc">pw_node_find_port()</a>, <a class="el" href="port_8c.html#a76fda7098a866ae2a145e156a6ae2cf8">pw_port_add()</a>, <a class="el" href="port_8c.html#a1f85df04626622240536feaad4b0932c">pw_port_use_buffers()</a>, and <a class="el" href="remote_8c.html#a878db8efbc88e0dd2d2d7aeef70ce4a6">pw_remote_find_proxy()</a>.</p> + +</div> +</div> +<a id="a07ee8a656f7e1ffbc10cb343b4881a86"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a07ee8a656f7e1ffbc10cb343b4881a86">◆ </a></span>pw_map_remove()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static void pw_map_remove </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__map.html">pw_map</a> * </td> + <td class="paramname"><em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Remove an item at index. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">map</td><td>the map to remove from </td></tr> + <tr><td class="paramname">id</td><td>the index to remove </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="structpw__map.html#acf2ad4417afa20b00e4a1f3837573d87">free_list</a>, and <a class="el" href="map_8h.html#ae4711748f39e5e8235faf961f35fb8a2">pw_map_get_item</a>.</p> + +<p class="reference">Referenced by <a class="el" href="structpw__memblock.html#a458b69a13b15233b8be7d1dd98c2c23f">pw_memblock::pw_memblock_free()</a>, and <a class="el" href="port_8c.html#a64d8c2251ba3a3bb1dff90176a27748f">pw_port_release_mix()</a>.</p> + +</div> +</div> +<h2 class="groupheader">Field Documentation</h2> +<a id="acf2ad4417afa20b00e4a1f3837573d87"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acf2ad4417afa20b00e4a1f3837573d87">◆ </a></span>free_list</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_map::free_list</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>the free items </p> + +<p class="reference">Referenced by <a class="el" href="structpw__map.html#acdd13c22e79cecf19a28d30e1154d323">pw_map_init()</a>, <a class="el" href="structpw__map.html#a39efc6ce617c07d672b287945cf7a46b">pw_map_insert_new()</a>, and <a class="el" href="structpw__map.html#a07ee8a656f7e1ffbc10cb343b4881a86">pw_map_remove()</a>.</p> + +</div> +</div> +<a id="a6fc621171dbc57de8c44d26f639d2f1b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6fc621171dbc57de8c44d26f639d2f1b">◆ </a></span>items</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__array.html">pw_array</a> pw_map::items</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>an array with the map items </p> + +<p class="reference">Referenced by <a class="el" href="structpw__map.html#adcd4d2843a41d2f0d70bfd80790a9518">pw_map_for_each()</a>, <a class="el" href="structpw__map.html#acdd13c22e79cecf19a28d30e1154d323">pw_map_init()</a>, <a class="el" href="structpw__map.html#a10124711c6ab6ad3c1b9e6cab49dc4e4">pw_map_insert_at()</a>, and <a class="el" href="structpw__map.html#a39efc6ce617c07d672b287945cf7a46b">pw_map_insert_new()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="map_8h_source.html">map.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="structpw__map.html">pw_map</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> + </ul> +</div> +</body> +</html> |