[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 / Notify.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.Notify</title>
4 <meta name="description" content="Notification manager">
5 <link rel="stylesheet" type="text/css" href="../../../xdoc.css" />
6 </head>
7 <body><div id="xdocWrapper"><div id="xdocContent">
8 <table class="xdocHdr"><tr>
9 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.ipc.</span><span class="xdoc-id">Notify</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/MessageQ.html" title="module MessageQ"><img class="xdocHdrArrow" src="../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/package.html" title="package ti.sdo.ipc"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/SharedRegion.html" title="module SharedRegion"><img class="xdocHdrArrow" src="../../../Arrow_right.png"/></a></td>
16 </table>
17 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html">index URL</a></div>
18 <p class="xdocHdrSummary">Notification manager</p>
19 <ul class="xdocToc">
20 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
21 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
22 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
23 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
24 </ul>
25 <div class="xdocBrief">
26 This module has a common header that can be found in the <a class="xdoc-link" href="../../../ti/ipc/package.html" title="ti.ipc">ti.ipc</a>
27 package. Application code should include the common header file (not the
28 RTSC-generated one):
30 <PRE>#include <ti/ipc/Notify.h></PRE>
32 The RTSC module must be used in the application's RTSC configuration file
33 (.cfg) if runtime APIs will be used in the application:
35 <PRE>Notify = xdc.useModule('ti.sdo.ipc.Notify');</PRE>
37 Documentation for all runtime APIs, instance configuration parameters,
38 error codes macros and type definitions available to the application
39 integrator can be found in the
40 <A HREF="../../../../doxygen/html/files.html">Doxygen documenation</A>
41 for the IPC product. However, the documentation presented on this page
42 should be referred to for information specific to the RTSC module, such as
43 module configuration, Errors, and Asserts.
44 [ <a class="xdocBrief" href="#xdoc-desc">more</a> ... ]
45 </div>
46 <span id='targ-synop'></span>
47 <table class="xdocLabel"><tr>
48 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
49 <td class="xdocLabelCenter">target-domain</td>
50 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/ipc/Notify-src.html"><span class="xdocLabelFile">ti/sdo/ipc/Notify.xdc</span></a></td>
51 </tr></table>
52 <div class="xdocSynT">
53 <div class="xdocSynCode">
54 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/Notify.h></span>
55 </div>
56 <table cellspacing="0" cellpadding="0" border="0">
57 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
59 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">Notify_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/Notify.html#per-instance_config_parameters" title="ti.sdo.ipc.Notify.Params">Notify_Params</a> *params);</div></td></tr>
60 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
62 <tr>
63 <td></td>
64 <td>
65 <div class="xdocSynTblPack">
66 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">Notify_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
67 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
68 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
69 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
70 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
71 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
72 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
73 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">Notify_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
74 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">Notify_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
75 </div>
76 </td>
77 </tr>
78 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
80 <tr>
81 <td></td>
82 <td>
83 <div class="xdocSynTblPack">
84 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Notify_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
85 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Notify_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
86 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Notify_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
87 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Notify_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
88 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Notify_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
89 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Notify_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
90 </div>
91 </td>
92 </tr>
93 <tr><td colspan='2'><div class='xdocSynTblHdr'>Defines</div></td></tr>
95 <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="#.M.A.X.E.V.E.N.T.S"><span class="xdoc-id">Notify_MAXEVENTS</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum number of events supported by the Notify module</span></span></a> (<i><span class="xdoc-kw2">UInt</span></i>)32</div></td></tr>
96 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
98 <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/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Object">Notify_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">Notify_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
99 <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">Notify_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">Notify_Object</span>;</div></td></tr>
100 <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">Notify_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
101 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">Notify_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">Notify_Struct</span>;</div></td></tr>
102 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
104 <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_already.Registered"><span class="xdoc-id">Notify_A_alreadyRegistered</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to re-register for given line and processor</span></span></a>;</div></td></tr>
105 <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_internal"><span class="xdoc-id">Notify_A_internal</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when an internal error is encountered</span></span></a>;</div></td></tr>
106 <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_inv.Argument"><span class="xdoc-id">Notify_A_invArgument</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when an argument is invalid</span></span></a>;</div></td></tr>
107 <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_not.Registered"><span class="xdoc-id">Notify_A_notRegistered</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use an unregistered Notify instance</span></span></a>;</div></td></tr>
108 <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_out.Of.Order.Nesting"><span class="xdoc-id">Notify_A_outOfOrderNesting</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when <span class="xdoc-link" href="Notify.html#restore" title="restore">restore</span> called with improper key</span></span></a>;</div></td></tr>
109 <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.Event"><span class="xdoc-id">Notify_A_reservedEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to improperly use a reserved event</span></span></a>;</div></td></tr>
110 <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="#num.Events"><span class="xdoc-id">Notify_numEvents</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of events supported by Notify</span></span></a>;</div></td></tr>
111 <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="#reserved.Events"><span class="xdoc-id">Notify_reservedEvents</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of reserved event numbers</span></span></a>;</div></td></tr>
112 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#send.Event.Poll.Count"><span class="xdoc-id">Notify_sendEventPollCount</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Poll for specified amount before sendEvent times out</span></span></a>;</div></td></tr>
113 </table>
114 <div class="xdocSynSpacer"> </div>
115 </div>
116 <span id="xdoc-desc"></span>
117 <span id="xdoc-sect-1"></span>
118 <div class="xdocSect">DETAILS</div>
119 <div class="xdocText">This module has a common header that can be found in the <a class="xdoc-link" href="../../../ti/ipc/package.html" title="ti.ipc">ti.ipc</a>
120 package. Application code should include the common header file (not the
121 RTSC-generated one):
123 <PRE>#include <ti/ipc/Notify.h></PRE>
125 The RTSC module must be used in the application's RTSC configuration file
126 (.cfg) if runtime APIs will be used in the application:
128 <PRE>Notify = xdc.useModule('ti.sdo.ipc.Notify');</PRE>
130 Documentation for all runtime APIs, instance configuration parameters,
131 error codes macros and type definitions available to the application
132 integrator can be found in the
133 <A HREF="../../../../doxygen/html/files.html">Doxygen documenation</A>
134 for the IPC product. However, the documentation presented on this page
135 should be referred to for information specific to the RTSC module, such as
136 module configuration, Errors, and Asserts.</div>
137 <div class="xdocText">The Notify module typically doesn't require much (if any) configuration at
138 static time. However, it is possible to reduce the amount of shared memory
139 used by the Notify subsystem by reducing the value of <a class="xdoc-link" href="Notify.html#num.Events" title="numEvents">numEvents</a>.</div>
140 <div id="xdocSep">
141 </div>
142 <div id="xdocElems">
143 <div class="xdocSynSpacer"> </div>
144 <a class="xdocAnchor" id=".M.A.X.E.V.E.N.T.S"></a>
145 <table class="xdocHdr"><tr>
146 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">MAXEVENTS</span></td>
147 <td class="xdocHdrArrow">
148 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
149 </table>
150 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.M.A.X.E.V.E.N.T.S">index URL</a></div>
151 <p class="xdocHdrSummaryDcl">Maximum number of events supported by the Notify module</p>
152 <span id='targ-synop'></span>
153 <table class="xdocLabel"><tr>
154 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
155 <td class="xdocLabelRight">target-domain</td>
156 </tr></table>
157 <div class="xdocSynTdcl">
158 <div class="xdocSynCode">
159 <tt></tt><tt></tt><span class="xdoc-kw3">#define</span> <span class="xdoc-id">Notify_MAXEVENTS</span> (<i><span class="xdoc-kw2">UInt</span></i>)32
160 </div>
161 </div>
162 <div class="xdocSynSpacer"> </div>
163 <div class="xdocSynSpacer"> </div>
164 <a class="xdocAnchor" id=".A_already.Registered"></a>
165 <table class="xdocHdr"><tr>
166 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">A_alreadyRegistered</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
167 <td class="xdocHdrArrow">
168 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
169 </table>
170 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_already.Registered">index URL</a></div>
171 <p class="xdocHdrSummaryDcl">Assert raised when trying to re-register for given line and processor</p>
172 <span id='targ-synop'></span>
173 <table class="xdocLabel"><tr>
174 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
175 <td class="xdocLabelRight">target-domain</td>
176 </tr></table>
177 <div class="xdocSynTdcl">
178 <div class="xdocSynCode">
179 <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">Notify_A_alreadyRegistered</span>;
180 </div>
181 </div>
182 <div class="xdocSynSpacer"> </div>
183 <div class="xdocSynSpacer"> </div>
184 <a class="xdocAnchor" id=".A_internal"></a>
185 <table class="xdocHdr"><tr>
186 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">A_internal</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
187 <td class="xdocHdrArrow">
188 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
189 </table>
190 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_internal">index URL</a></div>
191 <p class="xdocHdrSummaryDcl">Assert raised when an internal error is encountered</p>
192 <span id='targ-synop'></span>
193 <table class="xdocLabel"><tr>
194 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
195 <td class="xdocLabelRight">target-domain</td>
196 </tr></table>
197 <div class="xdocSynTdcl">
198 <div class="xdocSynCode">
199 <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">Notify_A_internal</span>;
200 </div>
201 </div>
202 <div class="xdocSynSpacer"> </div>
203 <div class="xdocSynSpacer"> </div>
204 <a class="xdocAnchor" id=".A_inv.Argument"></a>
205 <table class="xdocHdr"><tr>
206 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">A_invArgument</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
207 <td class="xdocHdrArrow">
208 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
209 </table>
210 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_inv.Argument">index URL</a></div>
211 <p class="xdocHdrSummaryDcl">Assert raised when an argument is invalid</p>
212 <span id='targ-synop'></span>
213 <table class="xdocLabel"><tr>
214 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
215 <td class="xdocLabelRight">target-domain</td>
216 </tr></table>
217 <div class="xdocSynTdcl">
218 <div class="xdocSynCode">
219 <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">Notify_A_invArgument</span>;
220 </div>
221 </div>
222 <div class="xdocSynSpacer"> </div>
223 <div class="xdocSynSpacer"> </div>
224 <a class="xdocAnchor" id=".A_not.Registered"></a>
225 <table class="xdocHdr"><tr>
226 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">A_notRegistered</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
227 <td class="xdocHdrArrow">
228 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
229 </table>
230 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_not.Registered">index URL</a></div>
231 <p class="xdocHdrSummaryDcl">Assert raised when trying to use an unregistered Notify instance</p>
232 <span id='targ-synop'></span>
233 <table class="xdocLabel"><tr>
234 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
235 <td class="xdocLabelRight">target-domain</td>
236 </tr></table>
237 <div class="xdocSynTdcl">
238 <div class="xdocSynCode">
239 <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">Notify_A_notRegistered</span>;
240 </div>
241 </div>
242 <div class="xdocSynSpacer"> </div>
243 <div class="xdocSynSpacer"> </div>
244 <a class="xdocAnchor" id=".A_out.Of.Order.Nesting"></a>
245 <table class="xdocHdr"><tr>
246 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">A_outOfOrderNesting</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
247 <td class="xdocHdrArrow">
248 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
249 </table>
250 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_out.Of.Order.Nesting">index URL</a></div>
251 <p class="xdocHdrSummaryDcl">Assert raised when <a class="xdoc-link" href="Notify.html#restore" title="restore">restore</a> called with improper key</p>
252 <span id='targ-synop'></span>
253 <table class="xdocLabel"><tr>
254 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
255 <td class="xdocLabelRight">target-domain</td>
256 </tr></table>
257 <div class="xdocSynTdcl">
258 <div class="xdocSynCode">
259 <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">Notify_A_outOfOrderNesting</span>;
260 </div>
261 </div>
262 <div class="xdocSynSpacer"> </div>
263 <div class="xdocSynSpacer"> </div>
264 <a class="xdocAnchor" id=".A_reserved.Event"></a>
265 <table class="xdocHdr"><tr>
266 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">A_reservedEvent</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
267 <td class="xdocHdrArrow">
268 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
269 </table>
270 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_reserved.Event">index URL</a></div>
271 <p class="xdocHdrSummaryDcl">Assert raised when trying to improperly use a reserved event</p>
272 <span id='targ-synop'></span>
273 <table class="xdocLabel"><tr>
274 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
275 <td class="xdocLabelRight">target-domain</td>
276 </tr></table>
277 <div class="xdocSynTdcl">
278 <div class="xdocSynCode">
279 <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">Notify_A_reservedEvent</span>;
280 </div>
281 </div>
282 <div class="xdocSynSpacer"> </div>
283 <div class="xdocSynSpacer"> </div>
284 <a class="xdocAnchor" id="num.Events"></a>
285 <table class="xdocHdr"><tr>
286 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">numEvents</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
287 <td class="xdocHdrArrow">
288 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
289 </table>
290 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#num.Events">index URL</a></div>
291 <p class="xdocHdrSummaryDcl">Number of events supported by Notify</p>
292 <span id='targ-synop'></span>
293 <table class="xdocLabel"><tr>
294 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
295 <td class="xdocLabelRight">target-domain</td>
296 </tr></table>
297 <div class="xdocSynTdcl">
298 <div class="xdocSynCode">
299 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">Notify_numEvents</span>;
300 </div>
301 </div>
302 <div class="xdocSynSpacer"> </div>
303 <span id="xdoc-sect-1"></span>
304 <div class="xdocSect">DETAILS</div>
305 <div class="xdocText">Lowering this value offers the benefit of lower footprint especially in
306 shared memory.</div>
307 <div class="xdocSynSpacer"> </div>
308 <a class="xdocAnchor" id="reserved.Events"></a>
309 <table class="xdocHdr"><tr>
310 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">reservedEvents</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
311 <td class="xdocHdrArrow">
312 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
313 </table>
314 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#reserved.Events">index URL</a></div>
315 <p class="xdocHdrSummaryDcl">Number of reserved event numbers</p>
316 <span id='targ-synop'></span>
317 <table class="xdocLabel"><tr>
318 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
319 <td class="xdocLabelRight">target-domain</td>
320 </tr></table>
321 <div class="xdocSynTdcl">
322 <div class="xdocSynCode">
323 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">Notify_reservedEvents</span>;
324 </div>
325 </div>
326 <div class="xdocSynSpacer"> </div>
327 <span id="xdoc-sect-1"></span>
328 <div class="xdocSect">DETAILS</div>
329 <div class="xdocText">The first reservedEvents event numbers are reserved for
330 middleware modules. Attempts to use these reserved events
331 will result in a <a class="xdoc-link" href="Notify.html#.A_reserved.Event" title="A_reservedEvent">A_reservedEvent</a> assert.</div>
332 <div class="xdocText">To use the reserved events, the top 16-bits of the eventId must equal
333 Notify_SYSTEMKEY.</div>
334 <div class="xdocSynSpacer"> </div>
335 <a class="xdocAnchor" id="send.Event.Poll.Count"></a>
336 <table class="xdocHdr"><tr>
337 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify_</span><span class="xdoc-id">sendEventPollCount</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
338 <td class="xdocHdrArrow">
339 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
340 </table>
341 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#send.Event.Poll.Count">index URL</a></div>
342 <p class="xdocHdrSummaryDcl">Poll for specified amount before sendEvent times out</p>
343 <span id='targ-synop'></span>
344 <table class="xdocLabel"><tr>
345 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
346 <td class="xdocLabelRight">target-domain</td>
347 </tr></table>
348 <div class="xdocSynTdcl">
349 <div class="xdocSynCode">
350 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">Notify_sendEventPollCount</span>;
351 </div>
352 </div>
353 <div class="xdocSynSpacer"> </div>
354 <span id="xdoc-sect-1"></span>
355 <div class="xdocSect">DETAILS</div>
356 <div class="xdocText">Setting a finite value for sendEventPollCount will cause
357 Notify_sendEvent to poll for an amount of time
358 proportional to this value when the 'waitClear' flag is TRUE.</div>
359 <a class="xdocAnchor" id="module-wide_built-ins"></a>
360 <table class="xdocHdr"><tr>
361 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
362 <td class="xdocHdrArrow">
363 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
364 </table>
365 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#module-wide_built-ins">index URL</a></div>
366 <p class="xdocHdrSummary"></p>
367 <span id='targ-synop'></span>
368 <table class="xdocLabel"><tr>
369 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
370 <td class="xdocLabelRight">target-domain</td>
371 </tr></table>
372 <div class="xdocSynTdcl">
373 <div class="xdocSynCode">
374 <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">Notify_Module_id</span>();
375 </div>
376 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
377 <div class="xdocSynSpacer"> </div>
378 <div class="xdocSynCode">
379 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">Notify_Module_startupDone</span>();
380 </div>
381 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
382 <div class="xdocSynSpacer"> </div>
383 <div class="xdocSynCode">
384 <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">Notify_Module_heap</span>();
385 </div>
386 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
387 <div class="xdocSynSpacer"> </div>
388 <div class="xdocSynCode">
389 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">Notify_Module_hasMask</span>();
390 </div>
391 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
392 <div class="xdocSynSpacer"> </div>
393 <div class="xdocSynCode">
394 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">Notify_Module_getMask</span>();
395 </div>
396 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
397 <div class="xdocSynSpacer"> </div>
398 <div class="xdocSynCode">
399 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Notify_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
400 </div>
401 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
402 </div>
403 <a class="xdocAnchor" id="per-instance_object_types"></a>
404 <table class="xdocHdr"><tr>
405 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
406 <td class="xdocHdrArrow">
407 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
408 </table>
409 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#per-instance_object_types">index URL</a></div>
410 <p class="xdocHdrSummary"></p>
411 <span id='targ-synop'></span>
412 <table class="xdocLabel"><tr>
413 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
414 <td class="xdocLabelRight">target-domain</td>
415 </tr></table>
416 <div class="xdocSynTdcl">
417 <div class="xdocSynCode">
418 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">Notify_Object</span> <span class="xdoc-id">Notify_Object</span>;
419 </div>
420 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
421 <div class="xdocSynSpacer"> </div>
422 <div class="xdocSynCode">
423 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Object">Notify_Object</a> *<span class="xdoc-id">Notify_Handle</span>;
424 </div>
425 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
426 <div class="xdocSynSpacer"> </div>
427 <div class="xdocSynCode">
428 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">Notify_Struct</span> <span class="xdoc-id">Notify_Struct</span>;
429 </div>
430 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
431 <div class="xdocSynSpacer"> </div>
432 <div class="xdocSynCode">
433 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> <span class="xdoc-id">Notify_handle</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Struct">Notify_Struct</a> *structP);
434 </div>
435 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
436 <div class="xdocSynSpacer"> </div>
437 <div class="xdocSynCode">
438 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Struct">Notify_Struct</a> *<span class="xdoc-id">Notify_struct</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> handle);
439 </div>
440 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
441 </div>
442 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
443 <table class="xdocHdr"><tr>
444 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
445 <td class="xdocHdrArrow">
446 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
447 </table>
448 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#per-instance_config_parameters">index URL</a></div>
449 <p class="xdocHdrSummary"></p>
450 <span id='targ-synop'></span>
451 <table class="xdocLabel"><tr>
452 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
453 <td class="xdocLabelRight">target-domain</td>
454 </tr></table>
455 <div class="xdocSynTdcl">
456 <div class="xdocSynCode">
457 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">Notify_Params</span> {
458 </div>
459 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
460 <div class="xdocSynCode">
461 <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;
462 </div>
463 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
464 <div class="xdocSynCode">
465 <tt></tt><tt></tt>} <span class="xdoc-id">Notify_Params</span>;
466 </div>
467 <div class="xdocSynSpacer"> </div>
468 <div class="xdocSynCode">
469 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Notify_Params_init</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_config_parameters" title="ti.sdo.ipc.Notify.Params">Notify_Params</a> *params);
470 </div>
471 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
472 </div>
473 <a class="xdocAnchor" id="per-instance_built-ins"></a>
474 <table class="xdocHdr"><tr>
475 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
476 <td class="xdocHdrArrow">
477 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
478 </table>
479 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#per-instance_built-ins">index URL</a></div>
480 <p class="xdocHdrSummary"></p>
481 <span id='targ-synop'></span>
482 <table class="xdocLabel"><tr>
483 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
484 <td class="xdocLabelRight">target-domain</td>
485 </tr></table>
486 <div class="xdocSynTdcl">
487 <div class="xdocSynCode">
488 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">Notify_Object_count</span>();
489 </div>
490 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
491 <div class="xdocSynSpacer"> </div>
492 <div class="xdocSynCode">
493 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> <span class="xdoc-id">Notify_Object_get</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Object">Notify_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
494 </div>
495 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
496 <div class="xdocSynSpacer"> </div>
497 <div class="xdocSynCode">
498 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> <span class="xdoc-id">Notify_Object_first</span>();
499 </div>
500 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
501 <div class="xdocSynSpacer"> </div>
502 <div class="xdocSynCode">
503 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> <span class="xdoc-id">Notify_Object_next</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> handle);
504 </div>
505 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
506 <div class="xdocSynSpacer"> </div>
507 <div class="xdocSynCode">
508 <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">Notify_Object_heap</span>();
509 </div>
510 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
511 <div class="xdocSynSpacer"> </div>
512 <div class="xdocSynCode">
513 <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">Notify_Handle_label</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> handle, <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
514 </div>
515 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
516 <div class="xdocSynSpacer"> </div>
517 <div class="xdocSynCode">
518 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">Notify_Handle_name</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/Notify.html#per-instance_object_types" title="ti.sdo.ipc.Notify.Handle">Notify_Handle</a> handle);
519 </div>
520 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
521 </div>
522 </div>
523 <div class="xdocSynSpacer"> </div>
524 <span id='meta-synop'></span>
525 <table class="xdocLabel"><tr>
526 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
527 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/ipc/Notify-src.html"><span class="xdocLabelFile">ti/sdo/ipc/Notify.xdc</span></a></td>
528 </tr></table>
529 <div class="xdocSynM">
530 <div class="xdocSynCode">
531 <tt></tt><span class="xdoc-kw1">var</span> Notify = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.Notify'</span>);
532 </div>
533 <div class='xdocSynHdr'>local proxy modules</div>
535 <div class="xdocSynCode">
536 <tt> </tt><tt></tt><a class="xdocSynGo" href="#.Setup.Proxy">Notify.<span class="xdoc-id">SetupProxy</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Device-specific Notify setup proxy</span></span></a> = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/INotifySetup.html" title="ti.sdo.ipc.interfaces.INotifySetup">INotifySetup</a>.Module</i> <span class="xdoc-kw2">null</span>
537 </div>
538 <div class="xdocSynCode">
539 <tt> </tt><tt> </tt><a class="xdocSynGo" href="#.Setup.Proxy" title="ti.sdo.ipc.Notify.SetupProxy">Notify.<span class="xdoc-id">SetupProxy</span></a>.delegate$ = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/INotifySetup.html" title="ti.sdo.ipc.interfaces.INotifySetup">INotifySetup</a>.Module</i> <span class="xdoc-kw2">null</span>
540 </div>
541 <div class='xdocSynHdr'>module-wide constants & types</div>
543 <div class="xdocSynCode">
544 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.M.A.X.E.V.E.N.T.S">Notify.<span class="xdoc-id">MAXEVENTS</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum number of events supported by the Notify module</span></span></a> = 32;
545 </div>
546 <div class='xdocSynHdr'>module-wide config parameters</div>
548 <div class="xdocSynCode">
549 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_already.Registered">Notify.<span class="xdoc-id">A_alreadyRegistered</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to re-register for given line and processor</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
550 </div>
551 <div class="xdocSynCode">
552 <tt> </tt><tt> </tt>msg: "A_alreadyRegistered: Notify instance for the processor/line already registered"
553 </div>
554 <div class="xdocSynCode">
555 <tt> </tt><tt></tt>};
556 </div>
557 <div class="xdocSynCode">
558 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_internal">Notify.<span class="xdoc-id">A_internal</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when an internal error is encountered</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
559 </div>
560 <div class="xdocSynCode">
561 <tt> </tt><tt> </tt>msg: "A_internal: An internal error has occurred"
562 </div>
563 <div class="xdocSynCode">
564 <tt> </tt><tt></tt>};
565 </div>
566 <div class="xdocSynCode">
567 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_inv.Argument">Notify.<span class="xdoc-id">A_invArgument</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when an argument is invalid</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
568 </div>
569 <div class="xdocSynCode">
570 <tt> </tt><tt> </tt>msg: "A_invArgument: Invalid argument supplied"
571 </div>
572 <div class="xdocSynCode">
573 <tt> </tt><tt></tt>};
574 </div>
575 <div class="xdocSynCode">
576 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_not.Registered">Notify.<span class="xdoc-id">A_notRegistered</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use an unregistered Notify instance</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
577 </div>
578 <div class="xdocSynCode">
579 <tt> </tt><tt> </tt>msg: "A_notRegistered: Notify instance not yet registered for the processor/line"
580 </div>
581 <div class="xdocSynCode">
582 <tt> </tt><tt></tt>};
583 </div>
584 <div class="xdocSynCode">
585 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_out.Of.Order.Nesting">Notify.<span class="xdoc-id">A_outOfOrderNesting</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when <span class="xdoc-link" href="Notify.html#restore" title="restore">restore</span> called with improper key</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
586 </div>
587 <div class="xdocSynCode">
588 <tt> </tt><tt> </tt>msg: "A_outOfOrderNesting: Out of order nesting"
589 </div>
590 <div class="xdocSynCode">
591 <tt> </tt><tt></tt>};
592 </div>
593 <div class="xdocSynCode">
594 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_reserved.Event">Notify.<span class="xdoc-id">A_reservedEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to improperly use a reserved event</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
595 </div>
596 <div class="xdocSynCode">
597 <tt> </tt><tt> </tt>msg: "A_reservedEvent: Improper use of a reserved event"
598 </div>
599 <div class="xdocSynCode">
600 <tt> </tt><tt></tt>};
601 </div>
602 <div class="xdocSynCode">
603 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metanum.Events">Notify.<span class="xdoc-id">numEvents</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of events supported by Notify</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 32;
604 </div>
605 <div class="xdocSynCode">
606 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metareserved.Events">Notify.<span class="xdoc-id">reservedEvents</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of reserved event numbers</span></span></a> = <i><span class="xdoc-kw2">UInt16</span></i> 5;
607 </div>
608 <div class="xdocSynCode">
609 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metasend.Event.Poll.Count">Notify.<span class="xdoc-id">sendEventPollCount</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Poll for specified amount before sendEvent times out</span></span></a> = <i><span class="xdoc-kw2">UInt32</span></i> -1;
610 </div>
611 <div class="xdocSynSpacer"> </div>
612 <div class="xdocSynCode">
613 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">Notify.<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>;
614 </div>
615 <div class="xdocSynCode">
616 <tt> </tt><tt></tt><a class="xdocSynGo" href="#rov.View.Info">Notify.<span class="xdoc-id">rovViewInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#.Instance" title="xdc.rov.ViewInfo.Instance">ViewInfo.Instance</a></i> <a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#per-instance_creation" title="xdc.rov.ViewInfo.create">ViewInfo.create</a>;
617 </div>
618 <div class='xdocSynHdr'>per-instance config parameters</div>
620 <div class="xdocSynCode">
621 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> Notify.<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>;
622 </div>
623 <div class="xdocSynSpacer"> </div>
624 </div>
625 <div id="xdocSep">
626 </div>
627 <div id="xdocMetaElems">
628 <div class="xdocSynSpacer"> </div>
629 <a class="xdocAnchor" id=".Setup.Proxy"></a>
630 <table class="xdocHdr"><tr>
631 <td class="xdocHdrTitle"><span class="xdoc-kw1">proxy</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">SetupProxy</span></td>
632 <td class="xdocHdrArrow">
633 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
634 </table>
635 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.Setup.Proxy">index URL</a></div>
636 <p class="xdocHdrSummaryDcl">Device-specific Notify setup proxy</p>
637 <span id='meta-synop'></span>
638 <table class="xdocLabel"><tr>
639 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
640 <td class="xdocLabelRight"></td>
641 </tr></table>
642 <div class="xdocSynMdcl">
643 <div class="xdocSynCode">
644 <tt></tt><tt></tt>Notify.<span class="xdoc-id">SetupProxy</span> = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/INotifySetup.html" title="ti.sdo.ipc.interfaces.INotifySetup">INotifySetup</a>.Module</i> <span class="xdoc-kw2">null</span>
645 </div>
646 <div class='xdocSynSum'><tt></tt><tt></tt>// some delegate module inheriting the <a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/INotifySetup.html" title="ti.sdo.ipc.interfaces.INotifySetup">INotifySetup</a> interface</div>
647 <div class="xdocSynCode">
648 <tt></tt><tt> </tt>Notify.<span class="xdoc-id">SetupProxy</span>.delegate$ = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/INotifySetup.html" title="ti.sdo.ipc.interfaces.INotifySetup">INotifySetup</a>.Module</i> <span class="xdoc-kw2">null</span>
649 </div>
650 <div class='xdocSynSum'><tt></tt><tt> </tt>// explicit access to the currently bound delegate module</div>
651 </div>
652 <div class="xdocSynSpacer"> </div>
653 <div class="xdocSynSpacer"> </div>
654 <a class="xdocAnchor" id="meta.M.A.X.E.V.E.N.T.S"></a>
655 <table class="xdocHdr"><tr>
656 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">MAXEVENTS</span></td>
657 <td class="xdocHdrArrow">
658 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
659 </table>
660 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.M.A.X.E.V.E.N.T.S">index URL</a></div>
661 <p class="xdocHdrSummaryDcl">Maximum number of events supported by the Notify module</p>
662 <span id='meta-synop'></span>
663 <table class="xdocLabel"><tr>
664 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
665 <td class="xdocLabelRight"></td>
666 </tr></table>
667 <div class="xdocSynMdcl">
668 <div class="xdocSynCode">
669 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> Notify.<span class="xdoc-id">MAXEVENTS</span> = 32;
670 </div>
671 </div>
672 <div class="xdocSynSpacer"> </div>
673 <div class="xdocSect">C SYNOPSIS</div>
674 <div class="xdocText"><a class="xdoc-link" href="#.M.A.X.E.V.E.N.T.S" title="Notify_MAXEVENTS">Notify_MAXEVENTS</a></div>
675 <div class="xdocSynSpacer"> </div>
676 <a class="xdocAnchor" id="meta.A_already.Registered"></a>
677 <table class="xdocHdr"><tr>
678 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">A_alreadyRegistered</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
679 <td class="xdocHdrArrow">
680 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
681 </table>
682 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_already.Registered">index URL</a></div>
683 <p class="xdocHdrSummaryDcl">Assert raised when trying to re-register for given line and processor</p>
684 <span id='meta-synop'></span>
685 <table class="xdocLabel"><tr>
686 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
687 <td class="xdocLabelRight"></td>
688 </tr></table>
689 <div class="xdocSynMdcl">
690 <div class="xdocSynCode">
691 <tt></tt><tt></tt>Notify.<span class="xdoc-id">A_alreadyRegistered</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
692 </div>
693 <div class="xdocSynCode">
694 <tt></tt><tt> </tt>msg: "A_alreadyRegistered: Notify instance for the processor/line already registered"
695 </div>
696 <div class="xdocSynCode">
697 <tt></tt><tt></tt>};
698 </div>
699 </div>
700 <div class="xdocSynSpacer"> </div>
701 <div class="xdocSect">C SYNOPSIS</div>
702 <div class="xdocText"><a class="xdoc-link" href="#.A_already.Registered" title="Notify_A_alreadyRegistered">Notify_A_alreadyRegistered</a></div>
703 <div class="xdocSynSpacer"> </div>
704 <a class="xdocAnchor" id="meta.A_internal"></a>
705 <table class="xdocHdr"><tr>
706 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">A_internal</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
707 <td class="xdocHdrArrow">
708 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
709 </table>
710 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_internal">index URL</a></div>
711 <p class="xdocHdrSummaryDcl">Assert raised when an internal error is encountered</p>
712 <span id='meta-synop'></span>
713 <table class="xdocLabel"><tr>
714 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
715 <td class="xdocLabelRight"></td>
716 </tr></table>
717 <div class="xdocSynMdcl">
718 <div class="xdocSynCode">
719 <tt></tt><tt></tt>Notify.<span class="xdoc-id">A_internal</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
720 </div>
721 <div class="xdocSynCode">
722 <tt></tt><tt> </tt>msg: "A_internal: An internal error has occurred"
723 </div>
724 <div class="xdocSynCode">
725 <tt></tt><tt></tt>};
726 </div>
727 </div>
728 <div class="xdocSynSpacer"> </div>
729 <div class="xdocSect">C SYNOPSIS</div>
730 <div class="xdocText"><a class="xdoc-link" href="#.A_internal" title="Notify_A_internal">Notify_A_internal</a></div>
731 <div class="xdocSynSpacer"> </div>
732 <a class="xdocAnchor" id="meta.A_inv.Argument"></a>
733 <table class="xdocHdr"><tr>
734 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">A_invArgument</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
735 <td class="xdocHdrArrow">
736 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
737 </table>
738 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_inv.Argument">index URL</a></div>
739 <p class="xdocHdrSummaryDcl">Assert raised when an argument is invalid</p>
740 <span id='meta-synop'></span>
741 <table class="xdocLabel"><tr>
742 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
743 <td class="xdocLabelRight"></td>
744 </tr></table>
745 <div class="xdocSynMdcl">
746 <div class="xdocSynCode">
747 <tt></tt><tt></tt>Notify.<span class="xdoc-id">A_invArgument</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
748 </div>
749 <div class="xdocSynCode">
750 <tt></tt><tt> </tt>msg: "A_invArgument: Invalid argument supplied"
751 </div>
752 <div class="xdocSynCode">
753 <tt></tt><tt></tt>};
754 </div>
755 </div>
756 <div class="xdocSynSpacer"> </div>
757 <div class="xdocSect">C SYNOPSIS</div>
758 <div class="xdocText"><a class="xdoc-link" href="#.A_inv.Argument" title="Notify_A_invArgument">Notify_A_invArgument</a></div>
759 <div class="xdocSynSpacer"> </div>
760 <a class="xdocAnchor" id="meta.A_not.Registered"></a>
761 <table class="xdocHdr"><tr>
762 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">A_notRegistered</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
763 <td class="xdocHdrArrow">
764 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
765 </table>
766 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_not.Registered">index URL</a></div>
767 <p class="xdocHdrSummaryDcl">Assert raised when trying to use an unregistered Notify instance</p>
768 <span id='meta-synop'></span>
769 <table class="xdocLabel"><tr>
770 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
771 <td class="xdocLabelRight"></td>
772 </tr></table>
773 <div class="xdocSynMdcl">
774 <div class="xdocSynCode">
775 <tt></tt><tt></tt>Notify.<span class="xdoc-id">A_notRegistered</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
776 </div>
777 <div class="xdocSynCode">
778 <tt></tt><tt> </tt>msg: "A_notRegistered: Notify instance not yet registered for the processor/line"
779 </div>
780 <div class="xdocSynCode">
781 <tt></tt><tt></tt>};
782 </div>
783 </div>
784 <div class="xdocSynSpacer"> </div>
785 <div class="xdocSect">C SYNOPSIS</div>
786 <div class="xdocText"><a class="xdoc-link" href="#.A_not.Registered" title="Notify_A_notRegistered">Notify_A_notRegistered</a></div>
787 <div class="xdocSynSpacer"> </div>
788 <a class="xdocAnchor" id="meta.A_out.Of.Order.Nesting"></a>
789 <table class="xdocHdr"><tr>
790 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">A_outOfOrderNesting</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
791 <td class="xdocHdrArrow">
792 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
793 </table>
794 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_out.Of.Order.Nesting">index URL</a></div>
795 <p class="xdocHdrSummaryDcl">Assert raised when <a class="xdoc-link" href="Notify.html#restore" title="restore">restore</a> called with improper key</p>
796 <span id='meta-synop'></span>
797 <table class="xdocLabel"><tr>
798 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
799 <td class="xdocLabelRight"></td>
800 </tr></table>
801 <div class="xdocSynMdcl">
802 <div class="xdocSynCode">
803 <tt></tt><tt></tt>Notify.<span class="xdoc-id">A_outOfOrderNesting</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
804 </div>
805 <div class="xdocSynCode">
806 <tt></tt><tt> </tt>msg: "A_outOfOrderNesting: Out of order nesting"
807 </div>
808 <div class="xdocSynCode">
809 <tt></tt><tt></tt>};
810 </div>
811 </div>
812 <div class="xdocSynSpacer"> </div>
813 <div class="xdocSect">C SYNOPSIS</div>
814 <div class="xdocText"><a class="xdoc-link" href="#.A_out.Of.Order.Nesting" title="Notify_A_outOfOrderNesting">Notify_A_outOfOrderNesting</a></div>
815 <div class="xdocSynSpacer"> </div>
816 <a class="xdocAnchor" id="meta.A_reserved.Event"></a>
817 <table class="xdocHdr"><tr>
818 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">A_reservedEvent</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
819 <td class="xdocHdrArrow">
820 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
821 </table>
822 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#.A_reserved.Event">index URL</a></div>
823 <p class="xdocHdrSummaryDcl">Assert raised when trying to improperly use a reserved event</p>
824 <span id='meta-synop'></span>
825 <table class="xdocLabel"><tr>
826 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
827 <td class="xdocLabelRight"></td>
828 </tr></table>
829 <div class="xdocSynMdcl">
830 <div class="xdocSynCode">
831 <tt></tt><tt></tt>Notify.<span class="xdoc-id">A_reservedEvent</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
832 </div>
833 <div class="xdocSynCode">
834 <tt></tt><tt> </tt>msg: "A_reservedEvent: Improper use of a reserved event"
835 </div>
836 <div class="xdocSynCode">
837 <tt></tt><tt></tt>};
838 </div>
839 </div>
840 <div class="xdocSynSpacer"> </div>
841 <div class="xdocSect">C SYNOPSIS</div>
842 <div class="xdocText"><a class="xdoc-link" href="#.A_reserved.Event" title="Notify_A_reservedEvent">Notify_A_reservedEvent</a></div>
843 <div class="xdocSynSpacer"> </div>
844 <a class="xdocAnchor" id="metanum.Events"></a>
845 <table class="xdocHdr"><tr>
846 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">numEvents</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
847 <td class="xdocHdrArrow">
848 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
849 </table>
850 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#num.Events">index URL</a></div>
851 <p class="xdocHdrSummaryDcl">Number of events supported by Notify</p>
852 <span id='meta-synop'></span>
853 <table class="xdocLabel"><tr>
854 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
855 <td class="xdocLabelRight"></td>
856 </tr></table>
857 <div class="xdocSynMdcl">
858 <div class="xdocSynCode">
859 <tt></tt><tt></tt>Notify.<span class="xdoc-id">numEvents</span> = <i><span class="xdoc-kw2">UInt</span></i> 32;
860 </div>
861 </div>
862 <div class="xdocSynSpacer"> </div>
863 <span id="xdoc-sect-1"></span>
864 <div class="xdocSect">DETAILS</div>
865 <div class="xdocText">Lowering this value offers the benefit of lower footprint especially in
866 shared memory.</div>
867 <div class="xdocSect">C SYNOPSIS</div>
868 <div class="xdocText"><a class="xdoc-link" href="#num.Events" title="Notify_numEvents">Notify_numEvents</a></div>
869 <div class="xdocSynSpacer"> </div>
870 <a class="xdocAnchor" id="metareserved.Events"></a>
871 <table class="xdocHdr"><tr>
872 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">reservedEvents</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
873 <td class="xdocHdrArrow">
874 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
875 </table>
876 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#reserved.Events">index URL</a></div>
877 <p class="xdocHdrSummaryDcl">Number of reserved event numbers</p>
878 <span id='meta-synop'></span>
879 <table class="xdocLabel"><tr>
880 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
881 <td class="xdocLabelRight"></td>
882 </tr></table>
883 <div class="xdocSynMdcl">
884 <div class="xdocSynCode">
885 <tt></tt><tt></tt>Notify.<span class="xdoc-id">reservedEvents</span> = <i><span class="xdoc-kw2">UInt16</span></i> 5;
886 </div>
887 </div>
888 <div class="xdocSynSpacer"> </div>
889 <span id="xdoc-sect-1"></span>
890 <div class="xdocSect">DETAILS</div>
891 <div class="xdocText">The first reservedEvents event numbers are reserved for
892 middleware modules. Attempts to use these reserved events
893 will result in a <a class="xdoc-link" href="Notify.html#.A_reserved.Event" title="A_reservedEvent">A_reservedEvent</a> assert.</div>
894 <div class="xdocText">To use the reserved events, the top 16-bits of the eventId must equal
895 Notify_SYSTEMKEY.</div>
896 <div class="xdocSect">C SYNOPSIS</div>
897 <div class="xdocText"><a class="xdoc-link" href="#reserved.Events" title="Notify_reservedEvents">Notify_reservedEvents</a></div>
898 <div class="xdocSynSpacer"> </div>
899 <a class="xdocAnchor" id="metasend.Event.Poll.Count"></a>
900 <table class="xdocHdr"><tr>
901 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">sendEventPollCount</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
902 <td class="xdocHdrArrow">
903 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
904 </table>
905 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#send.Event.Poll.Count">index URL</a></div>
906 <p class="xdocHdrSummaryDcl">Poll for specified amount before sendEvent times out</p>
907 <span id='meta-synop'></span>
908 <table class="xdocLabel"><tr>
909 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
910 <td class="xdocLabelRight"></td>
911 </tr></table>
912 <div class="xdocSynMdcl">
913 <div class="xdocSynCode">
914 <tt></tt><tt></tt>Notify.<span class="xdoc-id">sendEventPollCount</span> = <i><span class="xdoc-kw2">UInt32</span></i> -1;
915 </div>
916 </div>
917 <div class="xdocSynSpacer"> </div>
918 <span id="xdoc-sect-1"></span>
919 <div class="xdocSect">DETAILS</div>
920 <div class="xdocText">Setting a finite value for sendEventPollCount will cause
921 Notify_sendEvent to poll for an amount of time
922 proportional to this value when the 'waitClear' flag is TRUE.</div>
923 <div class="xdocSect">C SYNOPSIS</div>
924 <div class="xdocText"><a class="xdoc-link" href="#send.Event.Poll.Count" title="Notify_sendEventPollCount">Notify_sendEventPollCount</a></div>
925 <div class="xdocSynSpacer"> </div>
926 <a class="xdocAnchor" id="common$"></a>
927 <table class="xdocHdr"><tr>
928 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
929 <td class="xdocHdrArrow">
930 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
931 </table>
932 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#common$">index URL</a></div>
933 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
934 <span id='meta-synop'></span>
935 <table class="xdocLabel"><tr>
936 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
937 <td class="xdocLabelRight"></td>
938 </tr></table>
939 <div class="xdocSynMdcl">
940 <div class="xdocSynCode">
941 <tt></tt><tt></tt>Notify.<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>;
942 </div>
943 </div>
944 <div class="xdocSynSpacer"> </div>
945 <span id="xdoc-sect-1"></span>
946 <div class="xdocSect">DETAILS</div>
947 <div class="xdocText">All modules have this configuration parameter. Its name
948 contains the '$' character to ensure it does not conflict with
949 configuration parameters declared by the module. This allows
950 new configuration parameters to be added in the future without
951 any chance of breaking existing modules.</div>
952 <div class="xdocSynSpacer"> </div>
953 <a class="xdocAnchor" id="rov.View.Info"></a>
954 <table class="xdocHdr"><tr>
955 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">Notify.</span><span class="xdoc-id">rovViewInfo</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
956 <td class="xdocHdrArrow">
957 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
958 </table>
959 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#rov.View.Info">index URL</a></div>
960 <span id='meta-synop'></span>
961 <table class="xdocLabel"><tr>
962 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
963 <td class="xdocLabelRight"></td>
964 </tr></table>
965 <div class="xdocSynMdcl">
966 <div class="xdocSynCode">
967 <tt></tt><tt></tt>Notify.<span class="xdoc-id">rovViewInfo</span> = <i><a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#.Instance" title="xdc.rov.ViewInfo.Instance">ViewInfo.Instance</a></i> <a class="xdoc-link" href="../../../xdc/rov/ViewInfo.html#per-instance_creation" title="xdc.rov.ViewInfo.create">ViewInfo.create</a>;
968 </div>
969 </div>
970 <div class="xdocSynSpacer"> </div>
971 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
972 <table class="xdocHdr"><tr>
973 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
974 <td class="xdocHdrArrow">
975 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Notify.html" title="module Notify"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
976 </table>
977 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/Notify.html#per-instance_config_parameters">index URL</a></div>
978 <p class="xdocHdrSummary"></p>
979 <span id='meta-synop'></span>
980 <table class="xdocLabel"><tr>
981 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
982 <td class="xdocLabelRight"></td>
983 </tr></table>
984 <div class="xdocSynMdcl">
985 <div class="xdocSynCode">
986 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> Notify.<span class="xdoc-id">Params</span>;
987 </div>
988 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
989 </div>
990 </div>
991 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:24 GMT</div>
992 </div></div></body>
993 </html>