[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / nsremote / NameServerMessageQ.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/nsremote/NameServerMessageQ.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/nsremote/NameServerMessageQ.html
+++ /dev/null
@@ -1,967 +0,0 @@
-<html>
-<head>
-<title>module ti.sdo.ipc.nsremote.NameServerMessageQ</title>
-<meta name="description" content="Used by NameServer to communicate to remote processors">
-<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">module</span> <span class="xdoc-id">ti.sdo.ipc.nsremote.</span><span class="xdoc-id">NameServerMessageQ</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/package.html" title="package ti.sdo.ipc.nsremote"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerRemoteNotify.html" title="module NameServerRemoteNotify"><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/ipc/nsremote/NameServerMessageQ.html">index URL</a></div>
-<p class="xdocHdrSummary">Used by NameServer to communicate to remote processors</p>
-<ul class="xdocToc">
-<li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
-<li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
-</ul>
-<div class="xdocBrief">
-This module is used by <a class="xdoc-link" href="../../../../ti/sdo/utils/NameServer.html" title="ti.sdo.utils.NameServer">ti.sdo.utils.NameServer</a> to communicate
- to remote processors using <a class="xdoc-link" href="../../../../ti/sdo/ipc/MessageQ.html" title="ti.sdo.ipc.MessageQ">ti.sdo.ipc.MessageQ</a>.
- There needs to be one instance between each two cores in the system.
- Interrupts must be enabled before using this module.
- This module does not require any share memory.
-</div>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
-<td class="xdocLabelCenter">target-domain</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ-src.html"><span class="xdocLabelFile">ti/sdo/ipc/nsremote/NameServerMessageQ.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynT">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/nsremote/NameServerMessageQ.h></span>
-</div>
-<table cellspacing="0" cellpadding="0" border="0">
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
-
-<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">NameServerMessageQ_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/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Struct">NameServerMessageQ_Struct</a> *structP, <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">NameServerMessageQ_Params</a> *params);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">NameServerMessageQ_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-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">NameServerMessageQ_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>
-<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">NameServerMessageQ_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/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> *handleP);</div></td></tr>
-<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">NameServerMessageQ_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/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Struct">NameServerMessageQ_Struct</a> *structP);</div></td></tr>
-<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">NameServerMessageQ_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/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">NameServerMessageQ_Params</a> *params);</div></td></tr>
-<tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all INameServerRemote modules</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#attach"><span class="xdoc-id">NameServerMessageQ_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></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#detach"><span class="xdoc-id">NameServerMessageQ_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></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#get"><span class="xdoc-id">NameServerMessageQ_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle, <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></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">SizeT</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#shared.Mem.Req"><span class="xdoc-id">NameServerMessageQ_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></td></tr>
-<tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
-
-<tr>
-<td></td>
-<td>
-<div class="xdocSynTblPack">
-<a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NameServerMessageQ_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NameServerMessageQ_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NameServerMessageQ_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerMessageQ_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NameServerMessageQ_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
-</div>
-</td>
-</tr>
-<tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
-
-<tr>
-<td></td>
-<td>
-<div class="xdocSynTblPack">
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerMessageQ_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerMessageQ_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerMessageQ_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerMessageQ_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerMessageQ_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerMessageQ_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
-</div>
-</td>
-</tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Defines</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw3">#define</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#max.Name.Len"><span class="xdoc-id">NameServerMessageQ_maxNameLen</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// maximum number of characters for name in bytes</span></span></a> (<i><span class="xdoc-kw2">UInt</span></i>)32</div></td></tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
-
-<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/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Object">NameServerMessageQ_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NameServerMessageQ_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
-<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">NameServerMessageQ_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">NameServerMessageQ_Object</span>;</div></td></tr>
-<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">NameServerMessageQ_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Status"><span class="xdoc-id">NameServerMessageQ_Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Status codes returned by certain calls</span></span></a> ...</div></td></tr>
-<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">NameServerMessageQ_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">NameServerMessageQ_Struct</span>;</div></td></tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_name.Is.Too.Long"><span class="xdoc-id">NameServerMessageQ_A_nameIsTooLong</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised if too many characters in the name</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_reserved.Msg.Queue.Id"><span class="xdoc-id">NameServerMessageQ_A_reservedMsgQueueId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised if first MessageQ created already</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Id" title="xdc.runtime.Error.Id">Error_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.E_out.Of.Memory"><span class="xdoc-id">NameServerMessageQ_E_outOfMemory</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Error raised if all the message queue objects are taken</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt16</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#heap.Id"><span class="xdoc-id">NameServerMessageQ_heapId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which to alloc a message</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#timeout.In.Micro.Secs"><span class="xdoc-id">NameServerMessageQ_timeoutInMicroSecs</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The timeout value in terms of microseconds</span></span></a>;</div></td></tr>
-</table>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="max.Name.Len"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">maxNameLen</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#max.Name.Len">index URL</a></div>
-<p class="xdocHdrSummaryDcl">maximum number of characters for name in bytes</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw3">#define</span> <span class="xdoc-id">NameServerMessageQ_maxNameLen</span> (<i><span class="xdoc-kw2">UInt</span></i>)32
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<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">NameServerMessageQ_</span><span class="xdoc-id">Status</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.Status">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Status codes returned by certain calls</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> <span class="xdoc-id">NameServerMessageQ_Status</span> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-id">NameServerMessageQ_S_SUCCESS</span>,
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-id">NameServerMessageQ_E_FAIL</span>,
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-id">NameServerMessageQ_E_ERROR</span>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>} <span class="xdoc-id">NameServerMessageQ_Status</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".A_name.Is.Too.Long"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">A_nameIsTooLong</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.A_name.Is.Too.Long">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised if too many characters in the name</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">NameServerMessageQ_A_nameIsTooLong</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".A_reserved.Msg.Queue.Id"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">A_reservedMsgQueueId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.A_reserved.Msg.Queue.Id">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised if first MessageQ created already</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">NameServerMessageQ_A_reservedMsgQueueId</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".E_out.Of.Memory"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">E_outOfMemory</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.E_out.Of.Memory">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Error raised if all the message queue objects are taken</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Id" title="xdc.runtime.Error.Id">Error_Id</a> <span class="xdoc-id">NameServerMessageQ_E_outOfMemory</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="heap.Id"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">heapId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#heap.Id">index URL</a></div>
-<p class="xdocHdrSummaryDcl">The heap from which to alloc a message</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">NameServerMessageQ_heapId</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="timeout.In.Micro.Secs"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">timeoutInMicroSecs</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#timeout.In.Micro.Secs">index URL</a></div>
-<p class="xdocHdrSummaryDcl">The timeout value in terms of microseconds</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">NameServerMessageQ_timeoutInMicroSecs</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">A NameServer request will return after this amout of time
- without a response. The default timeout value is 1 s.
- To not wait, use the value of '0'. To wait forever, use '~(0)'.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="attach"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">NameServerMessageQ_</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/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#attach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function is called by Ipc_attach() through NameServer_SetupProxy</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerMessageQ_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">NameServerMessageQ_</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/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#detach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function is called by Ipc_detach() through NameServer_SetupProxy</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerMessageQ_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">NameServerMessageQ_</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/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#shared.Mem.Req">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Returns the shared memory size requirement for a single instance</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">NameServerMessageQ_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="module-wide_built-ins"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#module-wide_built-ins">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<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">NameServerMessageQ_Module_id</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NameServerMessageQ_Module_startupDone</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<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">NameServerMessageQ_Module_heap</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NameServerMessageQ_Module_hasMask</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">NameServerMessageQ_Module_getMask</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerMessageQ_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
-</div>
-<a class="xdocAnchor" id="per-instance_object_types"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NameServerMessageQ_Object</span> <span class="xdoc-id">NameServerMessageQ_Object</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Object">NameServerMessageQ_Object</a> *<span class="xdoc-id">NameServerMessageQ_Handle</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NameServerMessageQ_Struct</span> <span class="xdoc-id">NameServerMessageQ_Struct</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> <span class="xdoc-id">NameServerMessageQ_handle</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Struct">NameServerMessageQ_Struct</a> *structP);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Struct">NameServerMessageQ_Struct</a> *<span class="xdoc-id">NameServerMessageQ_struct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
-</div>
-<a class="xdocAnchor" id="per-instance_config_parameters"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NameServerMessageQ_Params</span> {
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
-<div class="xdocSynCode">
-<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;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>} <span class="xdoc-id">NameServerMessageQ_Params</span>;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerMessageQ_Params_init</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">NameServerMessageQ_Params</a> *params);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
-</div>
-<a class="xdocAnchor" id="per-instance_creation"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_creation">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> <span class="xdoc-id">NameServerMessageQ_create</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">NameServerMessageQ_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerMessageQ_construct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Struct">NameServerMessageQ_Struct</a> *structP, <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">NameServerMessageQ_Params</a> *params);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
-</div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">params</span>
-<span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">eb</span>
-<span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
-</div>
-<a class="xdocAnchor" id="per-instance_deletion"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_deletion">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerMessageQ_delete</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> *handleP);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerMessageQ_destruct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Struct">NameServerMessageQ_Struct</a> *structP);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="get"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">NameServerMessageQ_</span><span class="xdoc-id">get</span>() <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#get">index URL</a></div>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerMessageQ_get</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle, <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>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">handle</span>
-<span class="xdocChildSum">— handle of a previously-created <tt>NameServerMessageQ</tt> instance object</span>
-</div>
-<a class="xdocAnchor" id="per-instance_convertors"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_convertors">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/utils/INameServerRemote.html#per-instance_object_types" title="ti.sdo.utils.INameServerRemote.Handle">INameServerRemote_Handle</a> <span class="xdoc-id">NameServerMessageQ_Handle_upCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> <span class="xdoc-id">NameServerMessageQ_Handle_downCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/utils/INameServerRemote.html#per-instance_object_types" title="ti.sdo.utils.INameServerRemote.Handle">INameServerRemote_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
-</div>
-<a class="xdocAnchor" id="per-instance_built-ins"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_built-ins">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerMessageQ_Object_count</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> <span class="xdoc-id">NameServerMessageQ_Object_get</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Object">NameServerMessageQ_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> <span class="xdoc-id">NameServerMessageQ_Object_first</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> <span class="xdoc-id">NameServerMessageQ_Object_next</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<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">NameServerMessageQ_Object_heap</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<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">NameServerMessageQ_Handle_label</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">NameServerMessageQ_Handle_name</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#per-instance_object_types" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Handle">NameServerMessageQ_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ-src.html"><span class="xdocLabelFile">ti/sdo/ipc/nsremote/NameServerMessageQ.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynM">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">var</span> NameServerMessageQ = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.nsremote.NameServerMessageQ'</span>);
-</div>
-<div class='xdocSynHdr'>module-wide constants & types</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#metamax.Name.Len">NameServerMessageQ.<span class="xdoc-id">maxNameLen</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// maximum number of characters for name in bytes</span></span></a> = 32;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><i>values of type <a class="xdocSynGo" href="#meta.Status">NameServerMessageQ.<span class="xdoc-id">Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Status codes returned by certain calls</span></span></a></i>
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Status">NameServerMessageQ.<span class="xdoc-id">S_SUCCESS</span></a>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Status">NameServerMessageQ.<span class="xdoc-id">E_FAIL</span></a>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Status">NameServerMessageQ.<span class="xdoc-id">E_ERROR</span></a>;
-</div>
-<div class='xdocSynHdr'>module-wide config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_name.Is.Too.Long">NameServerMessageQ.<span class="xdoc-id">A_nameIsTooLong</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised if too many characters in the name</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "Too many characters in name"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_reserved.Msg.Queue.Id">NameServerMessageQ.<span class="xdoc-id">A_reservedMsgQueueId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised if first MessageQ created already</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "MessageQ Id 0 is reserved for NameServer"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.E_out.Of.Memory">NameServerMessageQ.<span class="xdoc-id">E_outOfMemory</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Error raised if all the message queue objects are taken</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Desc" title="xdc.runtime.Error.Desc">Error.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "E_outOfMemory: MessageQ_alloc faild from heap: %d"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#metaheap.Id">NameServerMessageQ.<span class="xdoc-id">heapId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which to alloc a message</span></span></a> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#metatimeout.In.Micro.Secs">NameServerMessageQ.<span class="xdoc-id">timeoutInMicroSecs</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The timeout value in terms of microseconds</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 1000000;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">NameServerMessageQ.<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>;
-</div>
-<div class='xdocSynHdr'>per-instance config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NameServerMessageQ.<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>;
-</div>
-<div class='xdocSynHdr'>per-instance creation</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = NameServerMessageQ.<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>(<i><span class="xdoc-kw2">UInt16</span></i> <span class="xdoc-id">procId</span>, params);
-</div>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocMetaElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metamax.Name.Len"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">NameServerMessageQ.</span><span class="xdoc-id">maxNameLen</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#max.Name.Len">index URL</a></div>
-<p class="xdocHdrSummaryDcl">maximum number of characters for name in bytes</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">const</span> NameServerMessageQ.<span class="xdoc-id">maxNameLen</span> = 32;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#max.Name.Len" title="NameServerMessageQ_maxNameLen">NameServerMessageQ_maxNameLen</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.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">NameServerMessageQ.</span><span class="xdoc-id">Status</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.Status">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Status codes returned by certain calls</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><i>values of type NameServerMessageQ.<span class="xdoc-id">Status</span></i>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw1">const</span> NameServerMessageQ.<span class="xdoc-id">S_SUCCESS</span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw1">const</span> NameServerMessageQ.<span class="xdoc-id">E_FAIL</span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw1">const</span> NameServerMessageQ.<span class="xdoc-id">E_ERROR</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.Status" title="NameServerMessageQ_Status">NameServerMessageQ_Status</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.A_name.Is.Too.Long"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ.</span><span class="xdoc-id">A_nameIsTooLong</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.A_name.Is.Too.Long">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised if too many characters in the name</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>NameServerMessageQ.<span class="xdoc-id">A_nameIsTooLong</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "Too many characters in name"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.A_name.Is.Too.Long" title="NameServerMessageQ_A_nameIsTooLong">NameServerMessageQ_A_nameIsTooLong</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.A_reserved.Msg.Queue.Id"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ.</span><span class="xdoc-id">A_reservedMsgQueueId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.A_reserved.Msg.Queue.Id">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised if first MessageQ created already</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>NameServerMessageQ.<span class="xdoc-id">A_reservedMsgQueueId</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "MessageQ Id 0 is reserved for NameServer"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.A_reserved.Msg.Queue.Id" title="NameServerMessageQ_A_reservedMsgQueueId">NameServerMessageQ_A_reservedMsgQueueId</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.E_out.Of.Memory"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ.</span><span class="xdoc-id">E_outOfMemory</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#.E_out.Of.Memory">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Error raised if all the message queue objects are taken</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>NameServerMessageQ.<span class="xdoc-id">E_outOfMemory</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Desc" title="xdc.runtime.Error.Desc">Error.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "E_outOfMemory: MessageQ_alloc faild from heap: %d"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.E_out.Of.Memory" title="NameServerMessageQ_E_outOfMemory">NameServerMessageQ_E_outOfMemory</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metaheap.Id"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ.</span><span class="xdoc-id">heapId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#heap.Id">index URL</a></div>
-<p class="xdocHdrSummaryDcl">The heap from which to alloc a message</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>NameServerMessageQ.<span class="xdoc-id">heapId</span> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#heap.Id" title="NameServerMessageQ_heapId">NameServerMessageQ_heapId</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metatimeout.In.Micro.Secs"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerMessageQ.</span><span class="xdoc-id">timeoutInMicroSecs</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#timeout.In.Micro.Secs">index URL</a></div>
-<p class="xdocHdrSummaryDcl">The timeout value in terms of microseconds</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>NameServerMessageQ.<span class="xdoc-id">timeoutInMicroSecs</span> = <i><span class="xdoc-kw2">UInt</span></i> 1000000;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">A NameServer request will return after this amout of time
- without a response. The default timeout value is 1 s.
- To not wait, use the value of '0'. To wait forever, use '~(0)'.</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#timeout.In.Micro.Secs" title="NameServerMessageQ_timeoutInMicroSecs">NameServerMessageQ_timeoutInMicroSecs</a></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">NameServerMessageQ.</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/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#common$">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>NameServerMessageQ.<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>;
-</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>
-<a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_config_parameters">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NameServerMessageQ.<span class="xdoc-id">Params</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
-</div>
-<a class="xdocAnchor" id="metaper-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/ipc/nsremote/NameServerMessageQ.html" title="module NameServerMessageQ"><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/ipc/nsremote/NameServerMessageQ.html#per-instance_creation">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NameServerMessageQ.<a class="xdoc-link" href="../../../../ti/sdo/ipc/nsremote/NameServerMessageQ.html#metaper-instance_config_parameters" title="ti.sdo.ipc.nsremote.NameServerMessageQ.Params">Params</a>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = NameServerMessageQ.<span class="xdoc-id">create</span>(<i><span class="xdoc-kw2">UInt16</span></i> <span class="xdoc-id">procId</span>, params);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
-</div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">params</span>
-<span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">eb</span>
-<span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
-</div>
-</div>
-<div id="xdocDate">generated on Mon, 23 May 2016 14:31:12 GMT</div>
-</div></div></body>
-</html>