[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / utils / List.html
1 <html>
2 <head>
3 <title>module ti.sdo.utils.List</title>
4 <meta name="description" content="Doubly Linked List Manager">
5 <link rel="stylesheet" type="text/css" href="../../../xdoc.css" />
6 </head>
7 <body><div id="xdocWrapper"><div id="xdocContent">
8 <table class="xdocHdr"><tr>
9 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.utils.</span><span class="xdoc-id">List</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../ti/sdo/utils/Build.html" title="module Build"><img class="xdocHdrArrow" src="../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../ti/sdo/utils/package.html" title="package ti.sdo.utils"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../ti/sdo/utils/MultiProc.html" title="module MultiProc"><img class="xdocHdrArrow" src="../../../Arrow_right.png"/></a></td>
16 </table>
17 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html">index URL</a></div>
18 <p class="xdocHdrSummary">Doubly Linked List Manager</p>
19 <ul class="xdocToc">
20 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
21 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
22 <li class="xdocToc"><a class="xdocToc" href="#xdoc-sect-1">DETAILS</a></li>
23 <li class="xdocToc"><a class="xdocToc" href="#xdoc-sect-2">LIST AS A QUEUE</a></li>
24 <li class="xdocToc"><a class="xdocToc" href="#xdoc-sect-3">LIST AS A STACK</a></li>
25 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
26 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
27 </ul>
28 <div class="xdocBrief">
29 The List module makes available a set of functions that manipulate
30 List objects accessed through handles of type List_Handle.
31 Each List contains a linked sequence of zero or more elements
32 referenced through variables of type List_Elem, which are typically
33 embedded as the first field within a structure.
34 [ <a class="xdocBrief" href="#xdoc-desc">more</a> ... ]
35 </div>
36 <span id='targ-synop'></span>
37 <table class="xdocLabel"><tr>
38 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
39 <td class="xdocLabelCenter">target-domain</td>
40 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/List-src.html"><span class="xdocLabelFile">ti/sdo/utils/List.xdc</span></a></td>
41 </tr></table>
42 <div class="xdocSynT">
43 <div class="xdocSynCode">
44 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/utils/List.h></span>
45 </div>
46 <table cellspacing="0" cellpadding="0" border="0">
47 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
49 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">List_construct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize a new instance object inside the provided structure</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Struct">List_Struct</a> *structP, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_config_parameters" title="ti.sdo.utils.List.Params">List_Params</a> *params);</div></td></tr>
50 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">List_create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Allocate and initialize a new instance object and return its handle</span></span></a>(<span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_config_parameters" title="ti.sdo.utils.List.Params">List_Params</a> *params, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);</div></td></tr>
51 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_deletion"><span class="xdoc-id">List_delete</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> *handleP);</div></td></tr>
52 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Ptr</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#dequeue"><span class="xdoc-id">List_dequeue</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get element from front of List (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);</div></td></tr>
53 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_deletion"><span class="xdoc-id">List_destruct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Finalize the instance object inside the provided structure</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Struct">List_Struct</a> *structP);</div></td></tr>
54 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#elem.Clear"><span class="xdoc-id">List_elemClear</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Clears a List element's pointers</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
55 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Bool</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#empty"><span class="xdoc-id">List_empty</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test for an empty List (atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);</div></td></tr>
56 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#enqueue"><span class="xdoc-id">List_enqueue</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Put element at end of List (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
57 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#enqueue.Head"><span class="xdoc-id">List_enqueueHead</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Put element at head of List (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
58 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Ptr</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#get"><span class="xdoc-id">List_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get element from front of List (atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);</div></td></tr>
59 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#insert"><span class="xdoc-id">List_insert</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Insert element at into a List (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">newElem</span>, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">curElem</span>);</div></td></tr>
60 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Ptr</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#next"><span class="xdoc-id">List_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Return next element in List (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
61 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">List_Params_init</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize this config-params structure with supplier-specified defaults before instance creation</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_config_parameters" title="ti.sdo.utils.List.Params">List_Params</a> *params);</div></td></tr>
62 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Ptr</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#prev"><span class="xdoc-id">List_prev</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Return previous element in List (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
63 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#put"><span class="xdoc-id">List_put</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Put element at end of List (atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
64 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#put.Head"><span class="xdoc-id">List_putHead</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Put element at head of List (atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
65 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#remove"><span class="xdoc-id">List_remove</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Remove elem from middle of list (non-atomic)</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);</div></td></tr>
66 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
68 <tr>
69 <td></td>
70 <td>
71 <div class="xdocSynTblPack">
72 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">List_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
73 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
74 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
75 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
76 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
77 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
78 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
79 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">List_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
80 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">List_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
81 </div>
82 </td>
83 </tr>
84 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
86 <tr>
87 <td></td>
88 <td>
89 <div class="xdocSynTblPack">
90 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">List_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
91 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">List_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
92 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">List_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
93 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">List_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
94 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">List_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
95 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">List_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
96 </div>
97 </td>
98 </tr>
99 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
101 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Elem"><span class="xdoc-id">List_Elem</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque List element</span></span></a> <span class="xdoc-id">List_Elem</span>;</div></td></tr>
102 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Object">List_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">List_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
103 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">List_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">List_Object</span>;</div></td></tr>
104 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">List_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
105 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">List_Struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque client structure large enough to hold an instance object</span></span></a> <span class="xdoc-id">List_Struct</span>;</div></td></tr>
106 </table>
107 <div class="xdocSynSpacer"> </div>
108 </div>
109 <span id="xdoc-desc"></span>
110 <span id="xdoc-sect-1"></span>
111 <div class="xdocSect">DETAILS</div>
112 <div class="xdocText">The List module makes available a set of functions that manipulate
113 List objects accessed through handles of type List_Handle.
114 Each List contains a linked sequence of zero or more elements
115 referenced through variables of type List_Elem, which are typically
116 embedded as the first field within a structure.</div>
117 <div class="xdocText">All List function are atomic unless noted otherwise in the API
118 descriptions. An atomic API means that the API completes in core
119 functionality without being interrupted. Therefore, atomic APIs are
120 thread-safe. An example is <a class="xdoc-link" href="List.html#put" title="put">put</a>. Multiple threads can call
121 <a class="xdoc-link" href="List.html#put" title="put">put</a> at the same time. The threads do not have to manage the
122 synchronization.</div>
123 <div class="xdocText">The <a class="xdoc-link" href="../../../xdc/runtime/Gate.html#enter.System" title="xdc.runtime.Gate.enterSystem">xdc.runtime.Gate.enterSystem</a>/<a class="xdoc-link" href="../../../xdc/runtime/Gate.html#leave.System" title="xdc.runtime.Gate.leaveSystem">xdc.runtime.Gate.leaveSystem</a>
124 calls are used to make the APIs atomic. This Gate calls internally use
125 <a class="xdoc-link" href="../../../xdc/runtime/System.html" title="xdc.runtime.System">xdc.runtime.System</a>'s gate.</div>
126 <div class="xdocText">The List module can be used both as a queue (i.e. First In First Out),
127 as a stack (i.e. Last In First Out), or as a general purpose linked list.</div>
128 <div class="xdocText">Lists are represented as doubly-linked lists, so calls to <a class="xdoc-link" href="List.html#next" title="next">next</a>
129 or <a class="xdoc-link" href="List.html#prev" title="prev">prev</a> can loop continuously over the List.
130 Refer to <a class="xdoc-link" href="List.html#next" title="next">next</a> and <a class="xdoc-link" href="List.html#prev" title="prev">prev</a> for examples.</div>
131 <span id="xdoc-sect-2"></span>
132 <div class="xdocSect">LIST AS A QUEUE</div>
133 <div class="xdocText"></div>
134 <div class="xdocText">To treat the list object as a queue:</div>
135 <div class="xdocText"><UL><LI>Use <a class="xdoc-link" href="List.html#put" title="put">put</a> to put at the tail of the queue
136 </LI><LI>Use <a class="xdoc-link" href="List.html#get" title="get">get</a> to get from the head of the queue
137 </LI></UL></div>
138 <div class="xdocText">Here is sample code that acts on a List instance (listHandle) as a queue
139 in a FIFO manner.</div>
140 <div class="xdocText"><PRE class="Example"> List_Elem elem[4];
141 List_Elem *tmpElem;
143 // place at the tail of the queue
144 for (i = 0; i < 4; i++) {
145 List_put(listHandle, &(elem[i]));
146 }
148 // remove the buffers from the head
149 while((tmpElem = List_get(listHandle)) != NULL) {
150 // process tmpElem
151 }
152 </PRE></div>
153 <span id="xdoc-sect-3"></span>
154 <div class="xdocSect">LIST AS A STACK</div>
155 <div class="xdocText"></div>
156 <div class="xdocText">To treat the list object as a stack:</div>
157 <div class="xdocText"><UL><LI>Use <a class="xdoc-link" href="List.html#put.Head" title="putHead">putHead</a> to put at the top of the stack
158 </LI><LI>Use <a class="xdoc-link" href="List.html#get" title="get">get</a> to get from the top of the stack
159 </LI></UL></div>
160 <div class="xdocText">Here is sample code that acts on a List instance (listHandle) as a stack
161 in a LIFO manner.</div>
162 <div class="xdocText"><PRE class="Example"> List_Elem elem[4];
163 List_Elem *tmpElem;
165 // push onto the top (i.e. head)
166 for (i = 0; i < 4; i++) {
167 List_putHead(listHandle, &(elem[i]));
168 }
170 // remove the buffers in FIFO order.
171 while((tmpElem = List_get(listHandle)) != NULL) {
172 // process tmpElem
173 }
174 </PRE></div>
175 <div id="xdocSep">
176 </div>
177 <div id="xdocElems">
178 <div class="xdocSynSpacer"> </div>
179 <a class="xdocAnchor" id=".Elem"></a>
180 <table class="xdocHdr"><tr>
181 <td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">List_</span><span class="xdoc-id">Elem</span></td>
182 <td class="xdocHdrArrow">
183 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
184 </table>
185 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#.Elem">index URL</a></div>
186 <p class="xdocHdrSummaryDcl">Opaque List element</p>
187 <span id='targ-synop'></span>
188 <table class="xdocLabel"><tr>
189 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
190 <td class="xdocLabelRight">target-domain</td>
191 </tr></table>
192 <div class="xdocSynTdcl">
193 <div class="xdocSynCode">
194 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">List_Elem</span> <span class="xdoc-id">List_Elem</span>;
195 </div>
196 </div>
197 <div class="xdocSynSpacer"> </div>
198 <span id="xdoc-sect-1"></span>
199 <div class="xdocSect">DETAILS</div>
200 <div class="xdocText">A field of this type is placed at the head of client structs.</div>
201 <div class="xdocSynSpacer"> </div>
202 <a class="xdocAnchor" id="elem.Clear"></a>
203 <table class="xdocHdr"><tr>
204 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">elemClear</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
205 <td class="xdocHdrArrow">
206 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
207 </table>
208 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#elem.Clear">index URL</a></div>
209 <p class="xdocHdrSummaryDcl">Clears a List element's pointers</p>
210 <span id='targ-synop'></span>
211 <table class="xdocLabel"><tr>
212 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
213 <td class="xdocLabelRight">target-domain</td>
214 </tr></table>
215 <div class="xdocSynTdcl">
216 <div class="xdocSynCode">
217 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_elemClear</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
218 </div>
219 </div>
220 <div class="xdocSynSpacer"> </div>
221 <span id="xdoc-sect-1"></span>
222 <div class="xdocSect">ARGUMENTS</div>
223 <div class="xdocChild"><span class="xdocChildId">elem</span>
224 <span class="xdocChildSum">— element to be cleared</span>
225 </div>
226 <span id="xdoc-sect-2"></span>
227 <div class="xdocSect">DETAILS</div>
228 <div class="xdocText">This API does not removing elements from a List, and
229 should never be called on an element in a List--only on deListed
230 elements.</div>
231 <a class="xdocAnchor" id="module-wide_built-ins"></a>
232 <table class="xdocHdr"><tr>
233 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
234 <td class="xdocHdrArrow">
235 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
236 </table>
237 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#module-wide_built-ins">index URL</a></div>
238 <p class="xdocHdrSummary"></p>
239 <span id='targ-synop'></span>
240 <table class="xdocLabel"><tr>
241 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
242 <td class="xdocLabelRight">target-domain</td>
243 </tr></table>
244 <div class="xdocSynTdcl">
245 <div class="xdocSynCode">
246 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Module.Id" title="xdc.runtime.Types.ModuleId">Types_ModuleId</a> <span class="xdoc-id">List_Module_id</span>();
247 </div>
248 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
249 <div class="xdocSynSpacer"> </div>
250 <div class="xdocSynCode">
251 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">List_Module_startupDone</span>();
252 </div>
253 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
254 <div class="xdocSynSpacer"> </div>
255 <div class="xdocSynCode">
256 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">List_Module_heap</span>();
257 </div>
258 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
259 <div class="xdocSynSpacer"> </div>
260 <div class="xdocSynCode">
261 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">List_Module_hasMask</span>();
262 </div>
263 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
264 <div class="xdocSynSpacer"> </div>
265 <div class="xdocSynCode">
266 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">List_Module_getMask</span>();
267 </div>
268 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
269 <div class="xdocSynSpacer"> </div>
270 <div class="xdocSynCode">
271 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
272 </div>
273 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
274 </div>
275 <a class="xdocAnchor" id="per-instance_object_types"></a>
276 <table class="xdocHdr"><tr>
277 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
278 <td class="xdocHdrArrow">
279 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
280 </table>
281 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_object_types">index URL</a></div>
282 <p class="xdocHdrSummary"></p>
283 <span id='targ-synop'></span>
284 <table class="xdocLabel"><tr>
285 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
286 <td class="xdocLabelRight">target-domain</td>
287 </tr></table>
288 <div class="xdocSynTdcl">
289 <div class="xdocSynCode">
290 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">List_Object</span> <span class="xdoc-id">List_Object</span>;
291 </div>
292 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
293 <div class="xdocSynSpacer"> </div>
294 <div class="xdocSynCode">
295 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Object">List_Object</a> *<span class="xdoc-id">List_Handle</span>;
296 </div>
297 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
298 <div class="xdocSynSpacer"> </div>
299 <div class="xdocSynCode">
300 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">List_Struct</span> <span class="xdoc-id">List_Struct</span>;
301 </div>
302 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
303 <div class="xdocSynSpacer"> </div>
304 <div class="xdocSynCode">
305 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> <span class="xdoc-id">List_handle</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Struct">List_Struct</a> *structP);
306 </div>
307 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
308 <div class="xdocSynSpacer"> </div>
309 <div class="xdocSynCode">
310 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Struct">List_Struct</a> *<span class="xdoc-id">List_struct</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);
311 </div>
312 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
313 </div>
314 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
315 <table class="xdocHdr"><tr>
316 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
317 <td class="xdocHdrArrow">
318 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
319 </table>
320 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_config_parameters">index URL</a></div>
321 <p class="xdocHdrSummary"></p>
322 <span id='targ-synop'></span>
323 <table class="xdocLabel"><tr>
324 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
325 <td class="xdocLabelRight">target-domain</td>
326 </tr></table>
327 <div class="xdocSynTdcl">
328 <div class="xdocSynCode">
329 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">List_Params</span> {
330 </div>
331 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
332 <div class="xdocSynCode">
333 <tt></tt><tt> </tt><a class="xdoc-link" href="../../../xdc/runtime/IInstance.html#per-instance_config_parameters" title="xdc.runtime.IInstance.Params">IInstance_Params</a> *instance;
334 </div>
335 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
336 <div class="xdocSynCode">
337 <tt></tt><tt></tt>} <span class="xdoc-id">List_Params</span>;
338 </div>
339 <div class="xdocSynSpacer"> </div>
340 <div class="xdocSynCode">
341 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_Params_init</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_config_parameters" title="ti.sdo.utils.List.Params">List_Params</a> *params);
342 </div>
343 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
344 </div>
345 <a class="xdocAnchor" id="per-instance_creation"></a>
346 <table class="xdocHdr"><tr>
347 <td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
348 <td class="xdocHdrArrow">
349 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
350 </table>
351 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_creation">index URL</a></div>
352 <p class="xdocHdrSummary"></p>
353 <span id='targ-synop'></span>
354 <table class="xdocLabel"><tr>
355 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
356 <td class="xdocLabelRight">target-domain</td>
357 </tr></table>
358 <div class="xdocSynTdcl">
359 <div class="xdocSynCode">
360 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> <span class="xdoc-id">List_create</span>(<span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_config_parameters" title="ti.sdo.utils.List.Params">List_Params</a> *params, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
361 </div>
362 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
363 <div class="xdocSynSpacer"> </div>
364 <div class="xdocSynCode">
365 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_construct</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Struct">List_Struct</a> *structP, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_config_parameters" title="ti.sdo.utils.List.Params">List_Params</a> *params);
366 </div>
367 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
368 </div>
369 <span id="xdoc-sect-1"></span>
370 <div class="xdocSect">ARGUMENTS</div>
371 <div class="xdocChild"><span class="xdocChildId">params</span>
372 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
373 </div>
374 <div class="xdocChild"><span class="xdocChildId">eb</span>
375 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
376 </div>
377 <a class="xdocAnchor" id="per-instance_deletion"></a>
378 <table class="xdocHdr"><tr>
379 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
380 <td class="xdocHdrArrow">
381 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
382 </table>
383 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_deletion">index URL</a></div>
384 <p class="xdocHdrSummary"></p>
385 <span id='targ-synop'></span>
386 <table class="xdocLabel"><tr>
387 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
388 <td class="xdocLabelRight">target-domain</td>
389 </tr></table>
390 <div class="xdocSynTdcl">
391 <div class="xdocSynCode">
392 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_delete</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> *handleP);
393 </div>
394 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
395 <div class="xdocSynSpacer"> </div>
396 <div class="xdocSynCode">
397 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_destruct</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Struct">List_Struct</a> *structP);
398 </div>
399 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
400 </div>
401 <div class="xdocSynSpacer"> </div>
402 <a class="xdocAnchor" id="dequeue"></a>
403 <table class="xdocHdr"><tr>
404 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">dequeue</span>() <small><span class="xdocSynSum">// instance</span></small></td>
405 <td class="xdocHdrArrow">
406 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
407 </table>
408 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#dequeue">index URL</a></div>
409 <p class="xdocHdrSummaryDcl">Get element from front of List (non-atomic)</p>
410 <span id='targ-synop'></span>
411 <table class="xdocLabel"><tr>
412 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
413 <td class="xdocLabelRight">target-domain</td>
414 </tr></table>
415 <div class="xdocSynTdcl">
416 <div class="xdocSynCode">
417 <tt></tt><tt></tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">List_dequeue</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);
418 </div>
419 </div>
420 <div class="xdocSynSpacer"> </div>
421 <span id="xdoc-sect-1"></span>
422 <div class="xdocSect">ARGUMENTS</div>
423 <div class="xdocChild"><span class="xdocChildId">handle</span>
424 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
425 </div>
426 <span id="xdoc-sect-2"></span>
427 <div class="xdocSect">RETURNS</div>
428 <div class="xdocText">pointer to former first element or NULL if empty</div>
429 <span id="xdoc-sect-3"></span>
430 <div class="xdocSect">DETAILS</div>
431 <div class="xdocText">This function atomically removes the element from the front of a
432 List and returns a pointer to it. This API is not thread safe.
433 Use <a class="xdoc-link" href="List.html#put" title="put">put</a> and <a class="xdoc-link" href="List.html#get" title="get">get</a> if multiple calling contexts
434 share the same list.</div>
435 <div class="xdocSynSpacer"> </div>
436 <a class="xdocAnchor" id="empty"></a>
437 <table class="xdocHdr"><tr>
438 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">empty</span>() <small><span class="xdocSynSum">// instance</span></small></td>
439 <td class="xdocHdrArrow">
440 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
441 </table>
442 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#empty">index URL</a></div>
443 <p class="xdocHdrSummaryDcl">Test for an empty List (atomic)</p>
444 <span id='targ-synop'></span>
445 <table class="xdocLabel"><tr>
446 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
447 <td class="xdocLabelRight">target-domain</td>
448 </tr></table>
449 <div class="xdocSynTdcl">
450 <div class="xdocSynCode">
451 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">List_empty</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);
452 </div>
453 </div>
454 <div class="xdocSynSpacer"> </div>
455 <span id="xdoc-sect-1"></span>
456 <div class="xdocSect">ARGUMENTS</div>
457 <div class="xdocChild"><span class="xdocChildId">handle</span>
458 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
459 </div>
460 <span id="xdoc-sect-2"></span>
461 <div class="xdocSect">RETURNS</div>
462 <div class="xdocText">TRUE if this List is empty</div>
463 <div class="xdocSynSpacer"> </div>
464 <a class="xdocAnchor" id="enqueue"></a>
465 <table class="xdocHdr"><tr>
466 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">enqueue</span>() <small><span class="xdocSynSum">// instance</span></small></td>
467 <td class="xdocHdrArrow">
468 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
469 </table>
470 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#enqueue">index URL</a></div>
471 <p class="xdocHdrSummaryDcl">Put element at end of List (non-atomic)</p>
472 <span id='targ-synop'></span>
473 <table class="xdocLabel"><tr>
474 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
475 <td class="xdocLabelRight">target-domain</td>
476 </tr></table>
477 <div class="xdocSynTdcl">
478 <div class="xdocSynCode">
479 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_enqueue</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
480 </div>
481 </div>
482 <div class="xdocSynSpacer"> </div>
483 <span id="xdoc-sect-1"></span>
484 <div class="xdocSect">ARGUMENTS</div>
485 <div class="xdocChild"><span class="xdocChildId">handle</span>
486 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
487 </div>
488 <div class="xdocChild"><span class="xdocChildId">elem</span>
489 <span class="xdocChildSum">— pointer to new List element</span>
490 </div>
491 <span id="xdoc-sect-2"></span>
492 <div class="xdocSect">DETAILS</div>
493 <div class="xdocText">This function places the element at the end of a List.
494 This API is not thread safe. Use <a class="xdoc-link" href="List.html#put" title="put">put</a> and <a class="xdoc-link" href="List.html#get" title="get">get</a>
495 if multiple calling contexts share the same list.</div>
496 <div class="xdocSynSpacer"> </div>
497 <a class="xdocAnchor" id="enqueue.Head"></a>
498 <table class="xdocHdr"><tr>
499 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">enqueueHead</span>() <small><span class="xdocSynSum">// instance</span></small></td>
500 <td class="xdocHdrArrow">
501 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
502 </table>
503 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#enqueue.Head">index URL</a></div>
504 <p class="xdocHdrSummaryDcl">Put element at head of List (non-atomic)</p>
505 <span id='targ-synop'></span>
506 <table class="xdocLabel"><tr>
507 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
508 <td class="xdocLabelRight">target-domain</td>
509 </tr></table>
510 <div class="xdocSynTdcl">
511 <div class="xdocSynCode">
512 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_enqueueHead</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
513 </div>
514 </div>
515 <div class="xdocSynSpacer"> </div>
516 <span id="xdoc-sect-1"></span>
517 <div class="xdocSect">ARGUMENTS</div>
518 <div class="xdocChild"><span class="xdocChildId">handle</span>
519 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
520 </div>
521 <div class="xdocChild"><span class="xdocChildId">elem</span>
522 <span class="xdocChildSum">— pointer to new List element</span>
523 </div>
524 <span id="xdoc-sect-2"></span>
525 <div class="xdocSect">DETAILS</div>
526 <div class="xdocText">This function places the element at the front of the List.
527 This API is not thread safe. Use <a class="xdoc-link" href="List.html#put.Head" title="putHead">putHead</a>
528 if multiple calling contexts share the same list.</div>
529 <div class="xdocSynSpacer"> </div>
530 <a class="xdocAnchor" id="get"></a>
531 <table class="xdocHdr"><tr>
532 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">get</span>() <small><span class="xdocSynSum">// instance</span></small></td>
533 <td class="xdocHdrArrow">
534 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
535 </table>
536 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#get">index URL</a></div>
537 <p class="xdocHdrSummaryDcl">Get element from front of List (atomic)</p>
538 <span id='targ-synop'></span>
539 <table class="xdocLabel"><tr>
540 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
541 <td class="xdocLabelRight">target-domain</td>
542 </tr></table>
543 <div class="xdocSynTdcl">
544 <div class="xdocSynCode">
545 <tt></tt><tt></tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">List_get</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);
546 </div>
547 </div>
548 <div class="xdocSynSpacer"> </div>
549 <span id="xdoc-sect-1"></span>
550 <div class="xdocSect">ARGUMENTS</div>
551 <div class="xdocChild"><span class="xdocChildId">handle</span>
552 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
553 </div>
554 <span id="xdoc-sect-2"></span>
555 <div class="xdocSect">RETURNS</div>
556 <div class="xdocText">pointer to former first element or NULL if empty</div>
557 <span id="xdoc-sect-3"></span>
558 <div class="xdocSect">DETAILS</div>
559 <div class="xdocText">This function atomically removes the element from the front of a
560 List and returns a pointer to it.</div>
561 <div class="xdocSynSpacer"> </div>
562 <a class="xdocAnchor" id="insert"></a>
563 <table class="xdocHdr"><tr>
564 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">insert</span>() <small><span class="xdocSynSum">// instance</span></small></td>
565 <td class="xdocHdrArrow">
566 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
567 </table>
568 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#insert">index URL</a></div>
569 <p class="xdocHdrSummaryDcl">Insert element at into a List (non-atomic)</p>
570 <span id='targ-synop'></span>
571 <table class="xdocLabel"><tr>
572 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
573 <td class="xdocLabelRight">target-domain</td>
574 </tr></table>
575 <div class="xdocSynTdcl">
576 <div class="xdocSynCode">
577 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_insert</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">newElem</span>, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">curElem</span>);
578 </div>
579 </div>
580 <div class="xdocSynSpacer"> </div>
581 <span id="xdoc-sect-1"></span>
582 <div class="xdocSect">ARGUMENTS</div>
583 <div class="xdocChild"><span class="xdocChildId">handle</span>
584 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
585 </div>
586 <div class="xdocChild"><span class="xdocChildId">newElem</span>
587 <span class="xdocChildSum">— element to insert</span>
588 </div>
589 <div class="xdocChild"><span class="xdocChildId">curElem</span>
590 <span class="xdocChildSum">— element to insert in front of</span>
591 </div>
592 <span id="xdoc-sect-2"></span>
593 <div class="xdocSect">DETAILS</div>
594 <div class="xdocText">This function inserts <tt>newElem</tt> in the queue in
595 front of <tt>curElem</tt>. The caller should protect the
596 list from being changed while using this call since it is non-atomic.</div>
597 <div class="xdocText">To place an elem at the end of the list, use <a class="xdoc-link" href="List.html#put" title="put">put</a>.
598 To place a elem at the front of the list, use <a class="xdoc-link" href="List.html#put.Head" title="putHead">putHead</a>.</div>
599 <div class="xdocSynSpacer"> </div>
600 <a class="xdocAnchor" id="next"></a>
601 <table class="xdocHdr"><tr>
602 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">next</span>() <small><span class="xdocSynSum">// instance</span></small></td>
603 <td class="xdocHdrArrow">
604 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
605 </table>
606 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#next">index URL</a></div>
607 <p class="xdocHdrSummaryDcl">Return next element in List (non-atomic)</p>
608 <span id='targ-synop'></span>
609 <table class="xdocLabel"><tr>
610 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
611 <td class="xdocLabelRight">target-domain</td>
612 </tr></table>
613 <div class="xdocSynTdcl">
614 <div class="xdocSynCode">
615 <tt></tt><tt></tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">List_next</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
616 </div>
617 </div>
618 <div class="xdocSynSpacer"> </div>
619 <span id="xdoc-sect-1"></span>
620 <div class="xdocSect">ARGUMENTS</div>
621 <div class="xdocChild"><span class="xdocChildId">handle</span>
622 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
623 </div>
624 <div class="xdocChild"><span class="xdocChildId">elem</span>
625 <span class="xdocChildSum">— element in list or NULL to start at the head</span>
626 </div>
627 <span id="xdoc-sect-2"></span>
628 <div class="xdocSect">RETURNS</div>
629 <div class="xdocText">next element in list or NULL to denote end</div>
630 <span id="xdoc-sect-3"></span>
631 <div class="xdocSect">DETAILS</div>
632 <div class="xdocText">This function returns the next element on a list. It does not
633 remove any items from the list. The caller should protect the
634 list from being changed while using this call since it is non-atomic.</div>
635 <div class="xdocText">To look at the first elem on the list, use NULL as the elem argument.</div>
636 <div class="xdocText">This function is useful in searching a list. The following code shows
637 an example. The scanning of a list should be protected against other
638 threads that modify the list.</div>
639 <div class="xdocText"><PRE class="Example"> List_Elem *elem = NULL;
641 // Begin protection against modification of the list.
643 while ((elem = List_next(listHandle, elem)) != NULL) {
644 //act elem as needed. For example call List_remove().
645 }
647 // End protection against modification of the list.
648 </PRE></div>
649 <div class="xdocSynSpacer"> </div>
650 <a class="xdocAnchor" id="prev"></a>
651 <table class="xdocHdr"><tr>
652 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">prev</span>() <small><span class="xdocSynSum">// instance</span></small></td>
653 <td class="xdocHdrArrow">
654 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
655 </table>
656 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#prev">index URL</a></div>
657 <p class="xdocHdrSummaryDcl">Return previous element in List (non-atomic)</p>
658 <span id='targ-synop'></span>
659 <table class="xdocLabel"><tr>
660 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
661 <td class="xdocLabelRight">target-domain</td>
662 </tr></table>
663 <div class="xdocSynTdcl">
664 <div class="xdocSynCode">
665 <tt></tt><tt></tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">List_prev</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
666 </div>
667 </div>
668 <div class="xdocSynSpacer"> </div>
669 <span id="xdoc-sect-1"></span>
670 <div class="xdocSect">ARGUMENTS</div>
671 <div class="xdocChild"><span class="xdocChildId">handle</span>
672 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
673 </div>
674 <div class="xdocChild"><span class="xdocChildId">elem</span>
675 <span class="xdocChildSum">— element in list or NULL to start at the end (i.e. tail)</span>
676 </div>
677 <span id="xdoc-sect-2"></span>
678 <div class="xdocSect">RETURNS</div>
679 <div class="xdocText">previous element in list or NULL to denote
680 no previous elem</div>
681 <span id="xdoc-sect-3"></span>
682 <div class="xdocSect">DETAILS</div>
683 <div class="xdocText">This function returns the previous element on a list. It does not
684 remove any items from the list. The caller should protect the
685 list from being changed while using this call since it is non-atomic.</div>
686 <div class="xdocText">To look at the last elem on the list, use NULL as the elem argument.</div>
687 <div class="xdocText">This function is useful in searching a list in reverse order. The
688 following code shows an example. The scanning of a list should be
689 protected against other threads that modify the list.</div>
690 <div class="xdocText"><PRE class="Example"> List_Elem *elem = NULL;
692 // Begin protection against modification of the list.
694 while ((elem = List_prev(listHandle, elem)) != NULL) {
695 //act elem as needed. For example call List_remove().
696 }
698 // End protection against modification of the list.
699 </PRE></div>
700 <div class="xdocSynSpacer"> </div>
701 <a class="xdocAnchor" id="put"></a>
702 <table class="xdocHdr"><tr>
703 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">put</span>() <small><span class="xdocSynSum">// instance</span></small></td>
704 <td class="xdocHdrArrow">
705 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
706 </table>
707 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#put">index URL</a></div>
708 <p class="xdocHdrSummaryDcl">Put element at end of List (atomic)</p>
709 <span id='targ-synop'></span>
710 <table class="xdocLabel"><tr>
711 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
712 <td class="xdocLabelRight">target-domain</td>
713 </tr></table>
714 <div class="xdocSynTdcl">
715 <div class="xdocSynCode">
716 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_put</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
717 </div>
718 </div>
719 <div class="xdocSynSpacer"> </div>
720 <span id="xdoc-sect-1"></span>
721 <div class="xdocSect">ARGUMENTS</div>
722 <div class="xdocChild"><span class="xdocChildId">handle</span>
723 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
724 </div>
725 <div class="xdocChild"><span class="xdocChildId">elem</span>
726 <span class="xdocChildSum">— pointer to new List element</span>
727 </div>
728 <span id="xdoc-sect-2"></span>
729 <div class="xdocSect">DETAILS</div>
730 <div class="xdocText">This function atomically places the element at the end of
731 List.</div>
732 <div class="xdocSynSpacer"> </div>
733 <a class="xdocAnchor" id="put.Head"></a>
734 <table class="xdocHdr"><tr>
735 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">putHead</span>() <small><span class="xdocSynSum">// instance</span></small></td>
736 <td class="xdocHdrArrow">
737 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
738 </table>
739 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#put.Head">index URL</a></div>
740 <p class="xdocHdrSummaryDcl">Put element at head of List (atomic)</p>
741 <span id='targ-synop'></span>
742 <table class="xdocLabel"><tr>
743 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
744 <td class="xdocLabelRight">target-domain</td>
745 </tr></table>
746 <div class="xdocSynTdcl">
747 <div class="xdocSynCode">
748 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_putHead</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
749 </div>
750 </div>
751 <div class="xdocSynSpacer"> </div>
752 <span id="xdoc-sect-1"></span>
753 <div class="xdocSect">ARGUMENTS</div>
754 <div class="xdocChild"><span class="xdocChildId">handle</span>
755 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
756 </div>
757 <div class="xdocChild"><span class="xdocChildId">elem</span>
758 <span class="xdocChildSum">— pointer to new List element</span>
759 </div>
760 <span id="xdoc-sect-2"></span>
761 <div class="xdocSect">DETAILS</div>
762 <div class="xdocText">This function atomically places the element at the front of
763 List.</div>
764 <div class="xdocSynSpacer"> </div>
765 <a class="xdocAnchor" id="remove"></a>
766 <table class="xdocHdr"><tr>
767 <td class="xdocHdrTitle"><span class="xdoc-id">List_</span><span class="xdoc-id">remove</span>() <small><span class="xdocSynSum">// instance</span></small></td>
768 <td class="xdocHdrArrow">
769 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
770 </table>
771 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#remove">index URL</a></div>
772 <p class="xdocHdrSummaryDcl">Remove elem from middle of list (non-atomic)</p>
773 <span id='targ-synop'></span>
774 <table class="xdocLabel"><tr>
775 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
776 <td class="xdocLabelRight">target-domain</td>
777 </tr></table>
778 <div class="xdocSynTdcl">
779 <div class="xdocSynCode">
780 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">List_remove</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List_Elem</a> *<span class="xdoc-id">elem</span>);
781 </div>
782 </div>
783 <div class="xdocSynSpacer"> </div>
784 <span id="xdoc-sect-1"></span>
785 <div class="xdocSect">ARGUMENTS</div>
786 <div class="xdocChild"><span class="xdocChildId">handle</span>
787 <span class="xdocChildSum">— handle of a previously-created <tt>List</tt> instance object</span>
788 </div>
789 <div class="xdocChild"><span class="xdocChildId">elem</span>
790 <span class="xdocChildSum">— element in list</span>
791 </div>
792 <span id="xdoc-sect-2"></span>
793 <div class="xdocSect">DETAILS</div>
794 <div class="xdocText">This function removes an elem from a list.
795 The <tt>elem</tt> parameter is a pointer to an existing element to be removed
796 from the List. The caller should protect the
797 list from being changed while using this call since it is non-atomic.</div>
798 <a class="xdocAnchor" id="per-instance_built-ins"></a>
799 <table class="xdocHdr"><tr>
800 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
801 <td class="xdocHdrArrow">
802 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
803 </table>
804 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_built-ins">index URL</a></div>
805 <p class="xdocHdrSummary"></p>
806 <span id='targ-synop'></span>
807 <table class="xdocLabel"><tr>
808 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
809 <td class="xdocLabelRight">target-domain</td>
810 </tr></table>
811 <div class="xdocSynTdcl">
812 <div class="xdocSynCode">
813 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">List_Object_count</span>();
814 </div>
815 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
816 <div class="xdocSynSpacer"> </div>
817 <div class="xdocSynCode">
818 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> <span class="xdoc-id">List_Object_get</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Object">List_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
819 </div>
820 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
821 <div class="xdocSynSpacer"> </div>
822 <div class="xdocSynCode">
823 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> <span class="xdoc-id">List_Object_first</span>();
824 </div>
825 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
826 <div class="xdocSynSpacer"> </div>
827 <div class="xdocSynCode">
828 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> <span class="xdoc-id">List_Object_next</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);
829 </div>
830 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
831 <div class="xdocSynSpacer"> </div>
832 <div class="xdocSynCode">
833 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">List_Object_heap</span>();
834 </div>
835 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
836 <div class="xdocSynSpacer"> </div>
837 <div class="xdocSynCode">
838 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *<span class="xdoc-id">List_Handle_label</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle, <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
839 </div>
840 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
841 <div class="xdocSynSpacer"> </div>
842 <div class="xdocSynCode">
843 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">List_Handle_name</span>(<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#per-instance_object_types" title="ti.sdo.utils.List.Handle">List_Handle</a> handle);
844 </div>
845 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
846 </div>
847 </div>
848 <div class="xdocSynSpacer"> </div>
849 <span id='meta-synop'></span>
850 <table class="xdocLabel"><tr>
851 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
852 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/List-src.html"><span class="xdocLabelFile">ti/sdo/utils/List.xdc</span></a></td>
853 </tr></table>
854 <div class="xdocSynM">
855 <div class="xdocSynCode">
856 <tt></tt><span class="xdoc-kw1">var</span> List = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.utils.List'</span>);
857 </div>
858 <div class='xdocSynHdr'>module-wide constants & types</div>
860 <div class="xdocSynCode">
861 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> <a class="xdocSynGo" href="#.Basic.View">List.<span class="xdoc-id">BasicView</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;
862 </div>
863 <div class="xdocSynCode">
864 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#.Basic.View" title="ti.sdo.utils.List.BasicView"><span class="xdoc-id">label</span></a> = <i><span class="xdoc-kw2">String</span></i><b> ...</b>
865 </div>
866 <div class="xdocSynCode">
867 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#.Basic.View" title="ti.sdo.utils.List.BasicView"><span class="xdoc-id">elems</span></a> = <i><span class="xdoc-kw2">Ptr</span>[<span class="xdoc-kw2"></span>]</i><b> ...</b>
868 </div>
869 <div class='xdocSynHdr'>module-wide config parameters</div>
871 <div class="xdocSynCode">
872 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">List.<span class="xdoc-id">common$</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Common module configuration parameters</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
873 </div>
874 <div class="xdocSynCode">
875 <tt> </tt><tt></tt><a class="xdocSynGo" href="#rov.View.Info">List.<span class="xdoc-id">rovViewInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#.Instance" title="xdc.rov.ViewInfo.Instance">ViewInfo.Instance</a></i> <a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#per-instance_creation" title="xdc.rov.ViewInfo.create">ViewInfo.create</a>;
876 </div>
877 <div class='xdocSynHdr'>module-wide functions</div>
879 <div class="xdocSynCode">
880 <tt> </tt><tt></tt><a class="xdocSynGo" href="#elem.Clear.Meta">List.<span class="xdoc-id">elemClearMeta</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Clears a List element's pointers</span></span></a>(<i><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List.Elem</a>*</i> <span class="xdoc-id">elem</span>) <i>returns</i> <i><span class="xdoc-kw2">Void</span></i>
881 </div>
882 <div class='xdocSynHdr'>per-instance config parameters</div>
884 <div class="xdocSynCode">
885 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> List.<a class="xdocSynGo" href="#metaper-instance_config_parameters"><span class="xdoc-id">Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params object</span></span></a>;
886 </div>
887 <div class='xdocSynHdr'>per-instance creation</div>
889 <div class="xdocSynCode">
890 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = List.<a class="xdocSynGo" href="#metaper-instance_creation"><span class="xdoc-id">create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Create an instance-object</span></span></a>(params);
891 </div>
892 <div class="xdocSynSpacer"> </div>
893 </div>
894 <div id="xdocSep">
895 </div>
896 <div id="xdocMetaElems">
897 <div class="xdocSynSpacer"> </div>
898 <a class="xdocAnchor" id=".Basic.View"></a>
899 <table class="xdocHdr"><tr>
900 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">struct</span> <span class="xdoc-id">List.</span><span class="xdoc-id">BasicView</span></td>
901 <td class="xdocHdrArrow">
902 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
903 </table>
904 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#.Basic.View">index URL</a></div>
905 <span id='meta-synop'></span>
906 <table class="xdocLabel"><tr>
907 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
908 <td class="xdocLabelRight"></td>
909 </tr></table>
910 <div class="xdocSynMdcl">
911 <div class="xdocSynCode">
912 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> List.<span class="xdoc-id">BasicView</span>;
913 </div>
914 <div class="xdocSynSpacer"> </div>
915 <div class="xdocSynCode">
916 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">label</span> = <i><span class="xdoc-kw2">String</span></i><b> ...</b>
917 </div>
918 <div class="xdocSynCode">
919 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">elems</span> = <i><span class="xdoc-kw2">Ptr</span>[<span class="xdoc-kw2"></span>]</i><b> ...</b>
920 </div>
921 </div>
922 <div class="xdocSynSpacer"> </div>
923 <div class="xdocSynSpacer"> </div>
924 <a class="xdocAnchor" id="common$"></a>
925 <table class="xdocHdr"><tr>
926 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">List.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
927 <td class="xdocHdrArrow">
928 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
929 </table>
930 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#common$">index URL</a></div>
931 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
932 <span id='meta-synop'></span>
933 <table class="xdocLabel"><tr>
934 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
935 <td class="xdocLabelRight"></td>
936 </tr></table>
937 <div class="xdocSynMdcl">
938 <div class="xdocSynCode">
939 <tt></tt><tt></tt>List.<span class="xdoc-id">common$</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
940 </div>
941 </div>
942 <div class="xdocSynSpacer"> </div>
943 <span id="xdoc-sect-1"></span>
944 <div class="xdocSect">DETAILS</div>
945 <div class="xdocText">All modules have this configuration parameter. Its name
946 contains the '$' character to ensure it does not conflict with
947 configuration parameters declared by the module. This allows
948 new configuration parameters to be added in the future without
949 any chance of breaking existing modules.</div>
950 <div class="xdocSynSpacer"> </div>
951 <a class="xdocAnchor" id="rov.View.Info"></a>
952 <table class="xdocHdr"><tr>
953 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">List.</span><span class="xdoc-id">rovViewInfo</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
954 <td class="xdocHdrArrow">
955 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
956 </table>
957 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#rov.View.Info">index URL</a></div>
958 <span id='meta-synop'></span>
959 <table class="xdocLabel"><tr>
960 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
961 <td class="xdocLabelRight"></td>
962 </tr></table>
963 <div class="xdocSynMdcl">
964 <div class="xdocSynCode">
965 <tt></tt><tt></tt>List.<span class="xdoc-id">rovViewInfo</span> = <i><a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#.Instance" title="xdc.rov.ViewInfo.Instance">ViewInfo.Instance</a></i> <a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#per-instance_creation" title="xdc.rov.ViewInfo.create">ViewInfo.create</a>;
966 </div>
967 </div>
968 <div class="xdocSynSpacer"> </div>
969 <div class="xdocSynSpacer"> </div>
970 <a class="xdocAnchor" id="elem.Clear.Meta"></a>
971 <table class="xdocHdr"><tr>
972 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-id">List.</span><span class="xdoc-id">elemClearMeta</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
973 <td class="xdocHdrArrow">
974 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
975 </table>
976 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#elem.Clear.Meta">index URL</a></div>
977 <p class="xdocHdrSummaryDcl">Clears a List element's pointers</p>
978 <span id='meta-synop'></span>
979 <table class="xdocLabel"><tr>
980 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
981 <td class="xdocLabelRight"></td>
982 </tr></table>
983 <div class="xdocSynMdcl">
984 <div class="xdocSynCode">
985 <tt></tt><tt></tt>List.<span class="xdoc-id">elemClearMeta</span>(<i><a class="xdoc-link" href="../../../ti/sdo/utils/List.html#.Elem" title="ti.sdo.utils.List.Elem">List.Elem</a>*</i> <span class="xdoc-id">elem</span>) <i>returns</i> <i><span class="xdoc-kw2">Void</span></i>
986 </div>
987 </div>
988 <div class="xdocSynSpacer"> </div>
989 <span id="xdoc-sect-1"></span>
990 <div class="xdocSect">ARGUMENTS</div>
991 <div class="xdocChild"><span class="xdocChildId">elem</span>
992 <span class="xdocChildSum">— element to be cleared</span>
993 </div>
994 <span id="xdoc-sect-2"></span>
995 <div class="xdocSect">DETAILS</div>
996 <div class="xdocText">This API is not for removing elements from a List, and
997 should never be called on an element in a List--only on deListed
998 elements.</div>
999 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
1000 <table class="xdocHdr"><tr>
1001 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
1002 <td class="xdocHdrArrow">
1003 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
1004 </table>
1005 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_config_parameters">index URL</a></div>
1006 <p class="xdocHdrSummary"></p>
1007 <span id='meta-synop'></span>
1008 <table class="xdocLabel"><tr>
1009 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1010 <td class="xdocLabelRight"></td>
1011 </tr></table>
1012 <div class="xdocSynMdcl">
1013 <div class="xdocSynCode">
1014 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> List.<span class="xdoc-id">Params</span>;
1015 </div>
1016 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
1017 </div>
1018 <a class="xdocAnchor" id="metaper-instance_creation"></a>
1019 <table class="xdocHdr"><tr>
1020 <td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
1021 <td class="xdocHdrArrow">
1022 <a class="xdocHdrLink" href="../../../ti/sdo/utils/List.html" title="module List"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
1023 </table>
1024 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/List.html#per-instance_creation">index URL</a></div>
1025 <p class="xdocHdrSummary"></p>
1026 <span id='meta-synop'></span>
1027 <table class="xdocLabel"><tr>
1028 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1029 <td class="xdocLabelRight"></td>
1030 </tr></table>
1031 <div class="xdocSynMdcl">
1032 <div class="xdocSynCode">
1033 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> List.<a class="xdoc-link" href="../../../ti/sdo/utils/List.html#metaper-instance_config_parameters" title="ti.sdo.utils.List.Params">Params</a>;
1034 </div>
1035 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
1036 <div class="xdocSynCode">
1037 <tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
1038 </div>
1039 <div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
1040 <div class="xdocSynSpacer"> </div>
1041 <div class="xdocSynCode">
1042 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = List.<span class="xdoc-id">create</span>(params);
1043 </div>
1044 <div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
1045 </div>
1046 <span id="xdoc-sect-1"></span>
1047 <div class="xdocSect">ARGUMENTS</div>
1048 <div class="xdocChild"><span class="xdocChildId">params</span>
1049 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
1050 </div>
1051 <div class="xdocChild"><span class="xdocChildId">eb</span>
1052 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
1053 </div>
1054 </div>
1055 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:10 GMT</div>
1056 </div></div></body>
1057 </html>