[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / namesrv / NameServerRemoteRpmsg.html
1 <html>
2 <head>
3 <title>module ti.ipc.namesrv.NameServerRemoteRpmsg</title>
4 <link rel="stylesheet" type="text/css" href="../../../xdoc.css" />
5 </head>
6 <body><div id="xdocWrapper"><div id="xdocContent">
7 <table class="xdocHdr"><tr>
8 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.ipc.namesrv.</span><span class="xdoc-id">NameServerRemoteRpmsg</span></td>
9 <td class="xdocHdrArrow">
10 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/package.html" title="package ti.ipc.namesrv"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
11 </table>
12 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html">index URL</a></div>
13 <ul class="xdocToc">
14 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
15 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
16 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
17 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
18 </ul>
19 <span id='targ-synop'></span>
20 <table class="xdocLabel"><tr>
21 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
22 <td class="xdocLabelCenter">target-domain</td>
23 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg-src.html"><span class="xdocLabelFile">ti/ipc/namesrv/NameServerRemoteRpmsg.xdc</span></a></td>
24 </tr></table>
25 <div class="xdocSynT">
26 <div class="xdocSynCode">
27 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/ipc/namesrv/NameServerRemoteRpmsg.h></span>
28 </div>
29 <table cellspacing="0" cellpadding="0" border="0">
30 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
32 <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">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Struct">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">NameServerRemoteRpmsg_Params</a> *params);</div></td></tr>
33 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">NameServerRemoteRpmsg_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>
34 <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">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> *handleP);</div></td></tr>
35 <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">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Struct">NameServerRemoteRpmsg_Struct</a> *structP);</div></td></tr>
36 <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">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">NameServerRemoteRpmsg_Params</a> *params);</div></td></tr>
37 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all INameServerRemote modules</div></td></tr>
39 <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">NameServerRemoteRpmsg_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>
40 <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">NameServerRemoteRpmsg_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>
41 <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">NameServerRemoteRpmsg_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_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>
42 <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">NameServerRemoteRpmsg_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>
43 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
45 <tr>
46 <td></td>
47 <td>
48 <div class="xdocSynTblPack">
49 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NameServerRemoteRpmsg_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
50 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NameServerRemoteRpmsg_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
51 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
52 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
53 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NameServerRemoteRpmsg_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
54 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
55 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
56 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
57 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
58 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
59 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NameServerRemoteRpmsg_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
60 </div>
61 </td>
62 </tr>
63 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
65 <tr>
66 <td></td>
67 <td>
68 <div class="xdocSynTblPack">
69 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
70 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
71 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
72 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
73 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
74 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NameServerRemoteRpmsg_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
75 </div>
76 </td>
77 </tr>
78 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
80 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Object">NameServerRemoteRpmsg_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NameServerRemoteRpmsg_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
81 <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">NameServerRemoteRpmsg_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">NameServerRemoteRpmsg_Object</span>;</div></td></tr>
82 <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">NameServerRemoteRpmsg_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
83 <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">NameServerRemoteRpmsg_Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Status codes returned by certain calls</span></span></a> ...</div></td></tr>
84 <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">NameServerRemoteRpmsg_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">NameServerRemoteRpmsg_Struct</span>;</div></td></tr>
85 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
87 <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">NameServerRemoteRpmsg_A_nameIsTooLong</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised if too many characters in the name</span></span></a>;</div></td></tr>
88 <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">NameServerRemoteRpmsg_timeoutInMicroSecs</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The timeout value in terms of microseconds</span></span></a>;</div></td></tr>
89 </table>
90 <div class="xdocSynSpacer"> </div>
91 </div>
92 <div id="xdocSep">
93 </div>
94 <div id="xdocElems">
95 <div class="xdocSynSpacer"> </div>
96 <a class="xdocAnchor" id=".Status"></a>
97 <a class="xdocAnchor" id=".S_.S.U.C.C.E.S.S"></a>
98 <a class="xdocAnchor" id=".E_.F.A.I.L"></a>
99 <a class="xdocAnchor" id=".E_.E.R.R.O.R"></a>
100 <table class="xdocHdr"><tr>
101 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">Status</span></td>
102 <td class="xdocHdrArrow">
103 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
104 </table>
105 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#.Status">index URL</a></div>
106 <p class="xdocHdrSummaryDcl">Status codes returned by certain calls</p>
107 <span id='targ-synop'></span>
108 <table class="xdocLabel"><tr>
109 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
110 <td class="xdocLabelRight">target-domain</td>
111 </tr></table>
112 <div class="xdocSynTdcl">
113 <div class="xdocSynCode">
114 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> <span class="xdoc-id">NameServerRemoteRpmsg_Status</span> {
115 </div>
116 <div class="xdocSynCode">
117 <tt></tt><tt> </tt><span class="xdoc-id">NameServerRemoteRpmsg_S_SUCCESS</span>,
118 </div>
119 <div class="xdocSynCode">
120 <tt></tt><tt> </tt><span class="xdoc-id">NameServerRemoteRpmsg_E_FAIL</span>,
121 </div>
122 <div class="xdocSynCode">
123 <tt></tt><tt> </tt><span class="xdoc-id">NameServerRemoteRpmsg_E_ERROR</span>
124 </div>
125 <div class="xdocSynCode">
126 <tt></tt><tt></tt>} <span class="xdoc-id">NameServerRemoteRpmsg_Status</span>;
127 </div>
128 </div>
129 <div class="xdocSynSpacer"> </div>
130 <div class="xdocSynSpacer"> </div>
131 <a class="xdocAnchor" id=".A_name.Is.Too.Long"></a>
132 <table class="xdocHdr"><tr>
133 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">A_nameIsTooLong</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
134 <td class="xdocHdrArrow">
135 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
136 </table>
137 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#.A_name.Is.Too.Long">index URL</a></div>
138 <p class="xdocHdrSummaryDcl">Assert raised if too many characters in the name</p>
139 <span id='targ-synop'></span>
140 <table class="xdocLabel"><tr>
141 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
142 <td class="xdocLabelRight">target-domain</td>
143 </tr></table>
144 <div class="xdocSynTdcl">
145 <div class="xdocSynCode">
146 <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">NameServerRemoteRpmsg_A_nameIsTooLong</span>;
147 </div>
148 </div>
149 <div class="xdocSynSpacer"> </div>
150 <div class="xdocSynSpacer"> </div>
151 <a class="xdocAnchor" id="timeout.In.Micro.Secs"></a>
152 <table class="xdocHdr"><tr>
153 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">timeoutInMicroSecs</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
154 <td class="xdocHdrArrow">
155 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
156 </table>
157 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#timeout.In.Micro.Secs">index URL</a></div>
158 <p class="xdocHdrSummaryDcl">The timeout value in terms of microseconds</p>
159 <span id='targ-synop'></span>
160 <table class="xdocLabel"><tr>
161 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
162 <td class="xdocLabelRight">target-domain</td>
163 </tr></table>
164 <div class="xdocSynTdcl">
165 <div class="xdocSynCode">
166 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">NameServerRemoteRpmsg_timeoutInMicroSecs</span>;
167 </div>
168 </div>
169 <div class="xdocSynSpacer"> </div>
170 <span id="xdoc-sect-1"></span>
171 <div class="xdocSect">DETAILS</div>
172 <div class="xdocText">A NameServer request will return after this amout of time
173 without a response. The default timeout value is 1 s.
174 To not wait, use the value of '0'. To wait forever, use '~(0)'.</div>
175 <div class="xdocSynSpacer"> </div>
176 <a class="xdocAnchor" id="attach"></a>
177 <table class="xdocHdr"><tr>
178 <td class="xdocHdrTitle"><span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">attach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
179 <td class="xdocHdrArrow">
180 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
181 </table>
182 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#attach">index URL</a></div>
183 <p class="xdocHdrSummaryDcl">Function is called by Ipc_attach() through NameServer_SetupProxy</p>
184 <span id='targ-synop'></span>
185 <table class="xdocLabel"><tr>
186 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
187 <td class="xdocLabelRight">target-domain</td>
188 </tr></table>
189 <div class="xdocSynTdcl">
190 <div class="xdocSynCode">
191 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerRemoteRpmsg_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>);
192 </div>
193 </div>
194 <div class="xdocSynSpacer"> </div>
195 <div class="xdocSynSpacer"> </div>
196 <a class="xdocAnchor" id="detach"></a>
197 <table class="xdocHdr"><tr>
198 <td class="xdocHdrTitle"><span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">detach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
199 <td class="xdocHdrArrow">
200 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
201 </table>
202 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#detach">index URL</a></div>
203 <p class="xdocHdrSummaryDcl">Function is called by Ipc_detach() through NameServer_SetupProxy</p>
204 <span id='targ-synop'></span>
205 <table class="xdocLabel"><tr>
206 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
207 <td class="xdocLabelRight">target-domain</td>
208 </tr></table>
209 <div class="xdocSynTdcl">
210 <div class="xdocSynCode">
211 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerRemoteRpmsg_detach</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);
212 </div>
213 </div>
214 <div class="xdocSynSpacer"> </div>
215 <div class="xdocSynSpacer"> </div>
216 <a class="xdocAnchor" id="shared.Mem.Req"></a>
217 <table class="xdocHdr"><tr>
218 <td class="xdocHdrTitle"><span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
219 <td class="xdocHdrArrow">
220 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
221 </table>
222 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#shared.Mem.Req">index URL</a></div>
223 <p class="xdocHdrSummaryDcl">Returns the shared memory size requirement for a single instance</p>
224 <span id='targ-synop'></span>
225 <table class="xdocLabel"><tr>
226 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
227 <td class="xdocLabelRight">target-domain</td>
228 </tr></table>
229 <div class="xdocSynTdcl">
230 <div class="xdocSynCode">
231 <tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">NameServerRemoteRpmsg_sharedMemReq</span>(<span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
232 </div>
233 </div>
234 <div class="xdocSynSpacer"> </div>
235 <span id="xdoc-sect-1"></span>
236 <div class="xdocSect">ARGUMENTS</div>
237 <div class="xdocChild"><span class="xdocChildId">sharedAddr</span>
238 <span class="xdocChildSum">— Shared address</span>
239 </div>
240 <span id="xdoc-sect-2"></span>
241 <div class="xdocSect">RETURNS</div>
242 <div class="xdocText">Number of MAUs needed to create the instance.</div>
243 <span id="xdoc-sect-3"></span>
244 <div class="xdocSect">DETAILS</div>
245 <div class="xdocText">Function is called during Ipc_attach() through NameServer_SetupProxy.</div>
246 <a class="xdocAnchor" id="module-wide_built-ins"></a>
247 <table class="xdocHdr"><tr>
248 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
249 <td class="xdocHdrArrow">
250 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
251 </table>
252 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#module-wide_built-ins">index URL</a></div>
253 <p class="xdocHdrSummary"></p>
254 <span id='targ-synop'></span>
255 <table class="xdocLabel"><tr>
256 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
257 <td class="xdocLabelRight">target-domain</td>
258 </tr></table>
259 <div class="xdocSynTdcl">
260 <div class="xdocSynCode">
261 <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">NameServerRemoteRpmsg_Module_id</span>();
262 </div>
263 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
264 <div class="xdocSynSpacer"> </div>
265 <div class="xdocSynCode">
266 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NameServerRemoteRpmsg_Module_startupDone</span>();
267 </div>
268 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
269 <div class="xdocSynSpacer"> </div>
270 <div class="xdocSynCode">
271 <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">NameServerRemoteRpmsg_Module_heap</span>();
272 </div>
273 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
274 <div class="xdocSynSpacer"> </div>
275 <div class="xdocSynCode">
276 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NameServerRemoteRpmsg_Module_hasMask</span>();
277 </div>
278 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
279 <div class="xdocSynSpacer"> </div>
280 <div class="xdocSynCode">
281 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">NameServerRemoteRpmsg_Module_getMask</span>();
282 </div>
283 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
284 <div class="xdocSynSpacer"> </div>
285 <div class="xdocSynCode">
286 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerRemoteRpmsg_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
287 </div>
288 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
289 </div>
290 <a class="xdocAnchor" id="per-instance_object_types"></a>
291 <table class="xdocHdr"><tr>
292 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
293 <td class="xdocHdrArrow">
294 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
295 </table>
296 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types">index URL</a></div>
297 <p class="xdocHdrSummary"></p>
298 <span id='targ-synop'></span>
299 <table class="xdocLabel"><tr>
300 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
301 <td class="xdocLabelRight">target-domain</td>
302 </tr></table>
303 <div class="xdocSynTdcl">
304 <div class="xdocSynCode">
305 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NameServerRemoteRpmsg_Object</span> <span class="xdoc-id">NameServerRemoteRpmsg_Object</span>;
306 </div>
307 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
308 <div class="xdocSynSpacer"> </div>
309 <div class="xdocSynCode">
310 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Object">NameServerRemoteRpmsg_Object</a> *<span class="xdoc-id">NameServerRemoteRpmsg_Handle</span>;
311 </div>
312 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
313 <div class="xdocSynSpacer"> </div>
314 <div class="xdocSynCode">
315 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NameServerRemoteRpmsg_Struct</span> <span class="xdoc-id">NameServerRemoteRpmsg_Struct</span>;
316 </div>
317 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
318 <div class="xdocSynSpacer"> </div>
319 <div class="xdocSynCode">
320 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> <span class="xdoc-id">NameServerRemoteRpmsg_handle</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Struct">NameServerRemoteRpmsg_Struct</a> *structP);
321 </div>
322 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
323 <div class="xdocSynSpacer"> </div>
324 <div class="xdocSynCode">
325 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Struct">NameServerRemoteRpmsg_Struct</a> *<span class="xdoc-id">NameServerRemoteRpmsg_struct</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> handle);
326 </div>
327 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
328 </div>
329 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
330 <table class="xdocHdr"><tr>
331 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
332 <td class="xdocHdrArrow">
333 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
334 </table>
335 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters">index URL</a></div>
336 <p class="xdocHdrSummary"></p>
337 <span id='targ-synop'></span>
338 <table class="xdocLabel"><tr>
339 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
340 <td class="xdocLabelRight">target-domain</td>
341 </tr></table>
342 <div class="xdocSynTdcl">
343 <div class="xdocSynCode">
344 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NameServerRemoteRpmsg_Params</span> {
345 </div>
346 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
347 <div class="xdocSynCode">
348 <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;
349 </div>
350 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
351 <div class="xdocSynCode">
352 <tt></tt><tt></tt>} <span class="xdoc-id">NameServerRemoteRpmsg_Params</span>;
353 </div>
354 <div class="xdocSynSpacer"> </div>
355 <div class="xdocSynCode">
356 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerRemoteRpmsg_Params_init</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">NameServerRemoteRpmsg_Params</a> *params);
357 </div>
358 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
359 </div>
360 <a class="xdocAnchor" id="per-instance_creation"></a>
361 <table class="xdocHdr"><tr>
362 <td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
363 <td class="xdocHdrArrow">
364 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
365 </table>
366 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_creation">index URL</a></div>
367 <p class="xdocHdrSummary"></p>
368 <span id='targ-synop'></span>
369 <table class="xdocLabel"><tr>
370 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
371 <td class="xdocLabelRight">target-domain</td>
372 </tr></table>
373 <div class="xdocSynTdcl">
374 <div class="xdocSynCode">
375 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> <span class="xdoc-id">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">NameServerRemoteRpmsg_Params</a> *params, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
376 </div>
377 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
378 <div class="xdocSynSpacer"> </div>
379 <div class="xdocSynCode">
380 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerRemoteRpmsg_construct</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Struct">NameServerRemoteRpmsg_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/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">NameServerRemoteRpmsg_Params</a> *params);
381 </div>
382 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
383 </div>
384 <span id="xdoc-sect-1"></span>
385 <div class="xdocSect">ARGUMENTS</div>
386 <div class="xdocChild"><span class="xdocChildId">params</span>
387 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
388 </div>
389 <div class="xdocChild"><span class="xdocChildId">eb</span>
390 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
391 </div>
392 <a class="xdocAnchor" id="per-instance_deletion"></a>
393 <table class="xdocHdr"><tr>
394 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
395 <td class="xdocHdrArrow">
396 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
397 </table>
398 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_deletion">index URL</a></div>
399 <p class="xdocHdrSummary"></p>
400 <span id='targ-synop'></span>
401 <table class="xdocLabel"><tr>
402 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
403 <td class="xdocLabelRight">target-domain</td>
404 </tr></table>
405 <div class="xdocSynTdcl">
406 <div class="xdocSynCode">
407 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerRemoteRpmsg_delete</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> *handleP);
408 </div>
409 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
410 <div class="xdocSynSpacer"> </div>
411 <div class="xdocSynCode">
412 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NameServerRemoteRpmsg_destruct</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Struct">NameServerRemoteRpmsg_Struct</a> *structP);
413 </div>
414 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
415 </div>
416 <div class="xdocSynSpacer"> </div>
417 <a class="xdocAnchor" id="get"></a>
418 <table class="xdocHdr"><tr>
419 <td class="xdocHdrTitle"><span class="xdoc-id">NameServerRemoteRpmsg_</span><span class="xdoc-id">get</span>() <small><span class="xdocSynSum">// instance</span></small></td>
420 <td class="xdocHdrArrow">
421 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
422 </table>
423 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#get">index URL</a></div>
424 <span id='targ-synop'></span>
425 <table class="xdocLabel"><tr>
426 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
427 <td class="xdocLabelRight">target-domain</td>
428 </tr></table>
429 <div class="xdocSynTdcl">
430 <div class="xdocSynCode">
431 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerRemoteRpmsg_get</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_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>);
432 </div>
433 </div>
434 <div class="xdocSynSpacer"> </div>
435 <span id="xdoc-sect-1"></span>
436 <div class="xdocSect">ARGUMENTS</div>
437 <div class="xdocChild"><span class="xdocChildId">handle</span>
438 <span class="xdocChildSum">— handle of a previously-created <tt>NameServerRemoteRpmsg</tt> instance object</span>
439 </div>
440 <a class="xdocAnchor" id="per-instance_convertors"></a>
441 <table class="xdocHdr"><tr>
442 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
443 <td class="xdocHdrArrow">
444 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
445 </table>
446 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_convertors">index URL</a></div>
447 <p class="xdocHdrSummary"></p>
448 <span id='targ-synop'></span>
449 <table class="xdocLabel"><tr>
450 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
451 <td class="xdocLabelRight">target-domain</td>
452 </tr></table>
453 <div class="xdocSynTdcl">
454 <div class="xdocSynCode">
455 <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">NameServerRemoteRpmsg_Handle_upCast</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> handle);
456 </div>
457 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
458 <div class="xdocSynSpacer"> </div>
459 <div class="xdocSynCode">
460 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> <span class="xdoc-id">NameServerRemoteRpmsg_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);
461 </div>
462 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
463 </div>
464 <a class="xdocAnchor" id="per-instance_built-ins"></a>
465 <table class="xdocHdr"><tr>
466 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
467 <td class="xdocHdrArrow">
468 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
469 </table>
470 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_built-ins">index URL</a></div>
471 <p class="xdocHdrSummary"></p>
472 <span id='targ-synop'></span>
473 <table class="xdocLabel"><tr>
474 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
475 <td class="xdocLabelRight">target-domain</td>
476 </tr></table>
477 <div class="xdocSynTdcl">
478 <div class="xdocSynCode">
479 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NameServerRemoteRpmsg_Object_count</span>();
480 </div>
481 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
482 <div class="xdocSynSpacer"> </div>
483 <div class="xdocSynCode">
484 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> <span class="xdoc-id">NameServerRemoteRpmsg_Object_get</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Object">NameServerRemoteRpmsg_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
485 </div>
486 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
487 <div class="xdocSynSpacer"> </div>
488 <div class="xdocSynCode">
489 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> <span class="xdoc-id">NameServerRemoteRpmsg_Object_first</span>();
490 </div>
491 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
492 <div class="xdocSynSpacer"> </div>
493 <div class="xdocSynCode">
494 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> <span class="xdoc-id">NameServerRemoteRpmsg_Object_next</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> handle);
495 </div>
496 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
497 <div class="xdocSynSpacer"> </div>
498 <div class="xdocSynCode">
499 <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">NameServerRemoteRpmsg_Object_heap</span>();
500 </div>
501 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
502 <div class="xdocSynSpacer"> </div>
503 <div class="xdocSynCode">
504 <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">NameServerRemoteRpmsg_Handle_label</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> handle, <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
505 </div>
506 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
507 <div class="xdocSynSpacer"> </div>
508 <div class="xdocSynCode">
509 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">NameServerRemoteRpmsg_Handle_name</span>(<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_object_types" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Handle">NameServerRemoteRpmsg_Handle</a> handle);
510 </div>
511 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
512 </div>
513 </div>
514 <div class="xdocSynSpacer"> </div>
515 <span id='meta-synop'></span>
516 <table class="xdocLabel"><tr>
517 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
518 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg-src.html"><span class="xdocLabelFile">ti/ipc/namesrv/NameServerRemoteRpmsg.xdc</span></a></td>
519 </tr></table>
520 <div class="xdocSynM">
521 <div class="xdocSynCode">
522 <tt></tt><span class="xdoc-kw1">var</span> NameServerRemoteRpmsg = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.ipc.namesrv.NameServerRemoteRpmsg'</span>);
523 </div>
524 <div class='xdocSynHdr'>module-wide constants & types</div>
526 <div class="xdocSynCode">
527 <tt> </tt><tt></tt><i>values of type <a class="xdocSynGo" href="#meta.Status">NameServerRemoteRpmsg.<span class="xdoc-id">Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Status codes returned by certain calls</span></span></a></i>
528 </div>
529 <div class="xdocSynCode">
530 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Status">NameServerRemoteRpmsg.<span class="xdoc-id">S_SUCCESS</span></a>;
531 </div>
532 <div class="xdocSynCode">
533 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Status">NameServerRemoteRpmsg.<span class="xdoc-id">E_FAIL</span></a>;
534 </div>
535 <div class="xdocSynCode">
536 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Status">NameServerRemoteRpmsg.<span class="xdoc-id">E_ERROR</span></a>;
537 </div>
538 <div class='xdocSynHdr'>module-wide config parameters</div>
540 <div class="xdocSynCode">
541 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_name.Is.Too.Long">NameServerRemoteRpmsg.<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> {
542 </div>
543 <div class="xdocSynCode">
544 <tt> </tt><tt> </tt>msg: "Too many characters in name"
545 </div>
546 <div class="xdocSynCode">
547 <tt> </tt><tt></tt>};
548 </div>
549 <div class="xdocSynCode">
550 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metatimeout.In.Micro.Secs">NameServerRemoteRpmsg.<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;
551 </div>
552 <div class="xdocSynSpacer"> </div>
553 <div class="xdocSynCode">
554 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">NameServerRemoteRpmsg.<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>;
555 </div>
556 <div class='xdocSynHdr'>per-instance config parameters</div>
558 <div class="xdocSynCode">
559 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NameServerRemoteRpmsg.<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>;
560 </div>
561 <div class='xdocSynHdr'>per-instance creation</div>
563 <div class="xdocSynCode">
564 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = NameServerRemoteRpmsg.<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);
565 </div>
566 <div class="xdocSynSpacer"> </div>
567 </div>
568 <div id="xdocSep">
569 </div>
570 <div id="xdocMetaElems">
571 <div class="xdocSynSpacer"> </div>
572 <a class="xdocAnchor" id="meta.Status"></a>
573 <a class="xdocAnchor" id=".S_.S.U.C.C.E.S.S"></a>
574 <a class="xdocAnchor" id=".E_.F.A.I.L"></a>
575 <a class="xdocAnchor" id=".E_.E.R.R.O.R"></a>
576 <table class="xdocHdr"><tr>
577 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">NameServerRemoteRpmsg.</span><span class="xdoc-id">Status</span></td>
578 <td class="xdocHdrArrow">
579 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
580 </table>
581 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#.Status">index URL</a></div>
582 <p class="xdocHdrSummaryDcl">Status codes returned by certain calls</p>
583 <span id='meta-synop'></span>
584 <table class="xdocLabel"><tr>
585 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
586 <td class="xdocLabelRight"></td>
587 </tr></table>
588 <div class="xdocSynMdcl">
589 <div class="xdocSynCode">
590 <tt></tt><tt></tt><i>values of type NameServerRemoteRpmsg.<span class="xdoc-id">Status</span></i>
591 </div>
592 <div class="xdocSynCode">
593 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> NameServerRemoteRpmsg.<span class="xdoc-id">S_SUCCESS</span>;
594 </div>
595 <div class="xdocSynCode">
596 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> NameServerRemoteRpmsg.<span class="xdoc-id">E_FAIL</span>;
597 </div>
598 <div class="xdocSynCode">
599 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> NameServerRemoteRpmsg.<span class="xdoc-id">E_ERROR</span>;
600 </div>
601 </div>
602 <div class="xdocSynSpacer"> </div>
603 <div class="xdocSect">C SYNOPSIS</div>
604 <div class="xdocText"><a class="xdoc-link" href="#.Status" title="NameServerRemoteRpmsg_Status">NameServerRemoteRpmsg_Status</a></div>
605 <div class="xdocSynSpacer"> </div>
606 <a class="xdocAnchor" id="meta.A_name.Is.Too.Long"></a>
607 <table class="xdocHdr"><tr>
608 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerRemoteRpmsg.</span><span class="xdoc-id">A_nameIsTooLong</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
609 <td class="xdocHdrArrow">
610 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
611 </table>
612 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#.A_name.Is.Too.Long">index URL</a></div>
613 <p class="xdocHdrSummaryDcl">Assert raised if too many characters in the name</p>
614 <span id='meta-synop'></span>
615 <table class="xdocLabel"><tr>
616 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
617 <td class="xdocLabelRight"></td>
618 </tr></table>
619 <div class="xdocSynMdcl">
620 <div class="xdocSynCode">
621 <tt></tt><tt></tt>NameServerRemoteRpmsg.<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> {
622 </div>
623 <div class="xdocSynCode">
624 <tt></tt><tt> </tt>msg: "Too many characters in name"
625 </div>
626 <div class="xdocSynCode">
627 <tt></tt><tt></tt>};
628 </div>
629 </div>
630 <div class="xdocSynSpacer"> </div>
631 <div class="xdocSect">C SYNOPSIS</div>
632 <div class="xdocText"><a class="xdoc-link" href="#.A_name.Is.Too.Long" title="NameServerRemoteRpmsg_A_nameIsTooLong">NameServerRemoteRpmsg_A_nameIsTooLong</a></div>
633 <div class="xdocSynSpacer"> </div>
634 <a class="xdocAnchor" id="metatimeout.In.Micro.Secs"></a>
635 <table class="xdocHdr"><tr>
636 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerRemoteRpmsg.</span><span class="xdoc-id">timeoutInMicroSecs</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
637 <td class="xdocHdrArrow">
638 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
639 </table>
640 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#timeout.In.Micro.Secs">index URL</a></div>
641 <p class="xdocHdrSummaryDcl">The timeout value in terms of microseconds</p>
642 <span id='meta-synop'></span>
643 <table class="xdocLabel"><tr>
644 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
645 <td class="xdocLabelRight"></td>
646 </tr></table>
647 <div class="xdocSynMdcl">
648 <div class="xdocSynCode">
649 <tt></tt><tt></tt>NameServerRemoteRpmsg.<span class="xdoc-id">timeoutInMicroSecs</span> = <i><span class="xdoc-kw2">UInt</span></i> 1000000;
650 </div>
651 </div>
652 <div class="xdocSynSpacer"> </div>
653 <span id="xdoc-sect-1"></span>
654 <div class="xdocSect">DETAILS</div>
655 <div class="xdocText">A NameServer request will return after this amout of time
656 without a response. The default timeout value is 1 s.
657 To not wait, use the value of '0'. To wait forever, use '~(0)'.</div>
658 <div class="xdocSect">C SYNOPSIS</div>
659 <div class="xdocText"><a class="xdoc-link" href="#timeout.In.Micro.Secs" title="NameServerRemoteRpmsg_timeoutInMicroSecs">NameServerRemoteRpmsg_timeoutInMicroSecs</a></div>
660 <div class="xdocSynSpacer"> </div>
661 <a class="xdocAnchor" id="common$"></a>
662 <table class="xdocHdr"><tr>
663 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">NameServerRemoteRpmsg.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
664 <td class="xdocHdrArrow">
665 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
666 </table>
667 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#common$">index URL</a></div>
668 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
669 <span id='meta-synop'></span>
670 <table class="xdocLabel"><tr>
671 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
672 <td class="xdocLabelRight"></td>
673 </tr></table>
674 <div class="xdocSynMdcl">
675 <div class="xdocSynCode">
676 <tt></tt><tt></tt>NameServerRemoteRpmsg.<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>;
677 </div>
678 </div>
679 <div class="xdocSynSpacer"> </div>
680 <span id="xdoc-sect-1"></span>
681 <div class="xdocSect">DETAILS</div>
682 <div class="xdocText">All modules have this configuration parameter. Its name
683 contains the '$' character to ensure it does not conflict with
684 configuration parameters declared by the module. This allows
685 new configuration parameters to be added in the future without
686 any chance of breaking existing modules.</div>
687 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
688 <table class="xdocHdr"><tr>
689 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
690 <td class="xdocHdrArrow">
691 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
692 </table>
693 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_config_parameters">index URL</a></div>
694 <p class="xdocHdrSummary"></p>
695 <span id='meta-synop'></span>
696 <table class="xdocLabel"><tr>
697 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
698 <td class="xdocLabelRight"></td>
699 </tr></table>
700 <div class="xdocSynMdcl">
701 <div class="xdocSynCode">
702 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NameServerRemoteRpmsg.<span class="xdoc-id">Params</span>;
703 </div>
704 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
705 </div>
706 <a class="xdocAnchor" id="metaper-instance_creation"></a>
707 <table class="xdocHdr"><tr>
708 <td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
709 <td class="xdocHdrArrow">
710 <a class="xdocHdrLink" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html" title="module NameServerRemoteRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
711 </table>
712 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/namesrv/NameServerRemoteRpmsg.html#per-instance_creation">index URL</a></div>
713 <p class="xdocHdrSummary"></p>
714 <span id='meta-synop'></span>
715 <table class="xdocLabel"><tr>
716 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
717 <td class="xdocLabelRight"></td>
718 </tr></table>
719 <div class="xdocSynMdcl">
720 <div class="xdocSynCode">
721 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NameServerRemoteRpmsg.<a class="xdoc-link" href="../../../ti/ipc/namesrv/NameServerRemoteRpmsg.html#metaper-instance_config_parameters" title="ti.ipc.namesrv.NameServerRemoteRpmsg.Params">Params</a>;
722 </div>
723 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
724 <div class="xdocSynCode">
725 <tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
726 </div>
727 <div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
728 <div class="xdocSynSpacer"> </div>
729 <div class="xdocSynCode">
730 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = NameServerRemoteRpmsg.<span class="xdoc-id">create</span>(<i><span class="xdoc-kw2">UInt16</span></i> <span class="xdoc-id">procId</span>, params);
731 </div>
732 <div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
733 </div>
734 <span id="xdoc-sect-1"></span>
735 <div class="xdocSect">ARGUMENTS</div>
736 <div class="xdocChild"><span class="xdocChildId">params</span>
737 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
738 </div>
739 <div class="xdocChild"><span class="xdocChildId">eb</span>
740 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
741 </div>
742 </div>
743 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:26 GMT</div>
744 </div></div></body>
745 </html>