[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / utils / INameServerRemote.html
diff --git a/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/utils/INameServerRemote.html b/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/utils/INameServerRemote.html
+++ /dev/null
@@ -1,276 +0,0 @@
-<html>
-<head>
-<title>interface ti.sdo.utils.INameServerRemote</title>
-<meta name="description" content="Interface for remote NameServer accesses">
-<link rel="stylesheet" type="text/css" href="../../../xdoc.css" />
-</head>
-<body><div id="xdocWrapper"><div id="xdocContent">
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">interface</span> <span class="xdoc-id">ti.sdo.utils.</span><span class="xdoc-id">INameServerRemote</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/package.html" title="package ti.sdo.utils"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/Build.html" title="module Build"><img class="xdocHdrArrow" src="../../../Arrow_right.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html">index URL</a></div>
-<p class="xdocHdrSummary">Interface for remote NameServer accesses</p>
-<ul class="xdocToc">
-<li class="xdocToc"><a class="xdocToc" href="#spec-synop">Specification synopsis</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
-</ul>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id">XDCspec</span></tt> summary</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynX">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">interface</span> <span class="xdoc-id">INameServerRemote</span> {<b> ...</b>
-</div>
-<div class='xdocSynSum'><tt></tt>// inherits <a class="xdoc-link" href="../../../xdc/runtime/IModule.html" title="xdc.runtime.IModule">xdc.runtime.IModule</a></div>
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">instance</span>:<b> ...</b>
-</div>
-</div>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynX">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">package</span> <a class="xdoc-link" href="../../../ti/sdo/utils/package.html" title="ti.sdo.utils">ti.sdo.utils</a>;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">interface</span> <span class="xdoc-id">INameServerRemote</span> {
-</div>
-<div class='xdocSynHdr'>module-wide constants & types</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">enum</span> <a class="xdocSynGo" href="#.Status"><span class="xdoc-id">Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Status codes returned by certain calls</span></span></a> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><a class="xdocSynGo" href="#.Status" title="ti.sdo.utils.INameServerRemote.Status"><span class="xdoc-id">S_SUCCESS</span></a>,
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><a class="xdocSynGo" href="#.Status" title="ti.sdo.utils.INameServerRemote.Status"><span class="xdoc-id">E_FAIL</span></a>,
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><a class="xdocSynGo" href="#.Status" title="ti.sdo.utils.INameServerRemote.Status"><span class="xdoc-id">E_ERROR</span></a>
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class='xdocSynHdr'>module-wide config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a> <a class="xdocSynGo" href="#common$"><span class="xdoc-id">common$</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Common module configuration parameters</span></span></a>;
-</div>
-<div class='xdocSynHdr'>module-wide functions</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">Int</span> <a class="xdocSynGo" href="#attach"><span class="xdoc-id">attach</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function is called by Ipc_attach() through NameServer_SetupProxy</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">Int</span> <a class="xdocSynGo" href="#detach"><span class="xdoc-id">detach</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function is called by Ipc_detach() through NameServer_SetupProxy</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">SizeT</span> <a class="xdocSynGo" href="#shared.Mem.Req"><span class="xdoc-id">sharedMemReq</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the shared memory size requirement for a single instance</span></span></a>(<span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">instance</span>:
-</div>
-<div class='xdocSynHdr'>per-instance creation</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Create an instance-object</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>);
-</div>
-<div class='xdocSynHdr'>per-instance functions</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">Int</span> <a class="xdocSynGo" href="#get"><span class="xdoc-id">get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<span class="xdoc-kw2">String</span> <span class="xdoc-id">instanceName</span>, <span class="xdoc-kw2">String</span> <span class="xdoc-id">name</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">value</span>, <span class="xdoc-kw2">UInt32</span> *<span class="xdoc-id">valueLen</span>, <a class="xdoc-link" href="../../../xdc/runtime/knl/ISync.html#per-instance_object_types" title="xdc.runtime.knl.ISync.Handle">ISync.Handle</a> <span class="xdoc-id">syncHandle</span>, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error.Block</a> *<span class="xdoc-id">eb</span>);
-</div>
-<div class="xdocSynCode">
-<tt></tt>}
-</div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".Status"></a>
-<a class="xdocAnchor" id=".S_.S.U.C.C.E.S.S"></a>
-<a class="xdocAnchor" id=".E_.F.A.I.L"></a>
-<a class="xdocAnchor" id=".E_.E.R.R.O.R"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">INameServerRemote.</span><span class="xdoc-id">Status</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#.Status">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Status codes returned by certain calls</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">enum</span> <span class="xdoc-id">Status</span> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-id">S_SUCCESS</span>,
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-id">E_FAIL</span>,
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-id">E_ERROR</span>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="common$"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">INameServerRemote.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#common$">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a> <span class="xdoc-id">common$</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">All modules have this configuration parameter. Its name
- contains the '$' character to ensure it does not conflict with
- configuration parameters declared by the module. This allows
- new configuration parameters to be added in the future without
- any chance of breaking existing modules.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="attach"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">INameServerRemote.</span><span class="xdoc-id">attach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#attach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function is called by Ipc_attach() through NameServer_SetupProxy</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">attach</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="detach"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">INameServerRemote.</span><span class="xdoc-id">detach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#detach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function is called by Ipc_detach() through NameServer_SetupProxy</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">detach</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="shared.Mem.Req"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">INameServerRemote.</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#shared.Mem.Req">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Returns the shared memory size requirement for a single instance</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">sharedMemReq</span>(<span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">sharedAddr</span>
-<span class="xdocChildSum">— Shared address</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">RETURNS</div>
-<div class="xdocText">Number of MAUs needed to create the instance.</div>
-<span id="xdoc-sect-3"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">Function is called during Ipc_attach() through NameServer_SetupProxy.</div>
-<a class="xdocAnchor" id="per-instance_creation"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#per-instance_creation">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-id">create</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="get"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">INameServerRemote.</span><span class="xdoc-id">get</span>() <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/sdo/utils/INameServerRemote.html" title="interface INameServerRemote"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/utils/INameServerRemote.html#get">index URL</a></div>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/utils/INameServerRemote-src.html"><span class="xdocLabelFile">ti/sdo/utils/INameServerRemote.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">get</span>(<span class="xdoc-kw2">String</span> <span class="xdoc-id">instanceName</span>, <span class="xdoc-kw2">String</span> <span class="xdoc-id">name</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">value</span>, <span class="xdoc-kw2">UInt32</span> *<span class="xdoc-id">valueLen</span>, <a class="xdoc-link" href="../../../xdc/runtime/knl/ISync.html#per-instance_object_types" title="xdc.runtime.knl.ISync.Handle">ISync.Handle</a> <span class="xdoc-id">syncHandle</span>, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error.Block</a> *<span class="xdoc-id">eb</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocDate">generated on Mon, 23 May 2016 14:31:09 GMT</div>
-</div></div></body>
-</html>