ipc_3_43_00_00_eng/docs/doxygen/html/struct_rcm_client___params.html

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.9.1"/>
   8 <title>IPC API: RcmClient_Params Struct Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <script type="text/javascript">
  16   $(document).ready(function() { init_search(); });
  17 </script>
  18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19 </head>
  20 <body>
  21 <table width="100%">
  22 <tr>
  23   <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
  24   <td bgcolor="red"><img src="titagline.gif" /></td>
  25 </tr>
  26 </table>
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr style="height: 56px;">
  32   <td style="padding-left: 0.5em;">
  33    <div id="projectname">IPC API
  34    &#160;<span id="projectnumber">3.43.00.00_eng</span>
  35    </div>
  36   </td>
  37  </tr>
  38  </tbody>
  39 </table>
  40 </div>
  41 <!-- end header part -->
  42 <!-- Generated by Doxygen 1.8.9.1 -->
  43 <script type="text/javascript">
  44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  45 </script>
  46   <div id="navrow1" class="tabs">
  47     <ul class="tablist">
  48       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  49       <li><a href="modules.html"><span>Modules</span></a></li>
  50       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  51       <li><a href="files.html"><span>Files</span></a></li>
  52       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  53       <li>
  54         <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <img id="MSearchSelect" src="search/mag_sel.png"
  57                onmouseover="return searchBox.OnSearchSelectShow()"
  58                onmouseout="return searchBox.OnSearchSelectHide()"
  59                alt=""/>
  60           <input type="text" id="MSearchField" value="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  66           </span>
  67         </div>
  68       </li>
  69     </ul>
  70   </div>
  71   <div id="navrow2" class="tabs2">
  72     <ul class="tablist">
  73       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  74       <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  75       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  76     </ul>
  77   </div>
  78 <!-- window showing the filter options -->
  79 <div id="MSearchSelectWindow"
  80      onmouseover="return searchBox.OnSearchSelectShow()"
  81      onmouseout="return searchBox.OnSearchSelectHide()"
  82      onkeydown="return searchBox.OnSearchSelectKey(event)">
  83 </div>
  84
  85 <!-- iframe showing the search results (closed by default) -->
  86 <div id="MSearchResultsWindow">
  87 <iframe src="javascript:void(0)" frameborder="0"
  88         name="MSearchResults" id="MSearchResults">
  89 </iframe>
  90 </div>
  91
  92 </div><!-- top -->
  93 <div class="header">
  94   <div class="summary">
  95 <a href="#pub-attribs">Data Fields</a>  </div>
  96   <div class="headertitle">
  97 <div class="title">RcmClient_Params Struct Reference<div class="ingroups"><a class="el" href="group__ti__grcm___rcm_client.html">RcmClient</a></div></div>  </div>
  98 </div><!--header-->
  99 <div class="contents">
 100
 101 <p>Instance create parameters.
 102  <a href="struct_rcm_client___params.html#details">More...</a></p>
 103
 104 <p><code>#include &lt;<a class="el" href="_rcm_client_8h_source.html">RcmClient.h</a>&gt;</code></p>
 105 <div class="dynheader">
 106 Collaboration diagram for RcmClient_Params:</div>
 107 <div class="dyncontent">
 108 <div class="center"><img src="struct_rcm_client___params__coll__graph.png" border="0" usemap="#_rcm_client___params_coll__map" alt="Collaboration graph"/></div>
 109 <map name="_rcm_client___params_coll__map" id="_rcm_client___params_coll__map">
 110 </map>
 111 </div>
 112 <table class="memberdecls">
 113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 114 Data Fields</h2></td></tr>
 115 <tr class="memitem:a749d7bf2f910bed2e3c303d8730141e1"><td class="memItemLeft" align="right" valign="top">UInt16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_rcm_client___params.html#a749d7bf2f910bed2e3c303d8730141e1">heapId</a></td></tr>
 116 <tr class="memdesc:a749d7bf2f910bed2e3c303d8730141e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The heapId used by this instance for allocating messages.  <a href="#a749d7bf2f910bed2e3c303d8730141e1">More...</a><br /></td></tr>
 117 <tr class="separator:a749d7bf2f910bed2e3c303d8730141e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 <tr class="memitem:ab507acff4f4c36dbcad01e67a0f2b8de"><td class="memItemLeft" align="right" valign="top">Bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_rcm_client___params.html#ab507acff4f4c36dbcad01e67a0f2b8de">callbackNotification</a></td></tr>
 119 <tr class="memdesc:ab507acff4f4c36dbcad01e67a0f2b8de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Asynchronous callback notification support.  <a href="#ab507acff4f4c36dbcad01e67a0f2b8de">More...</a><br /></td></tr>
 120 <tr class="separator:ab507acff4f4c36dbcad01e67a0f2b8de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 </table>
 122 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 123 <div class="textblock"><p>Instance create parameters. </p>
 124 </div><h2 class="groupheader">Field Documentation</h2>
 125 <a class="anchor" id="a749d7bf2f910bed2e3c303d8730141e1"></a>
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">UInt16 RcmClient_Params::heapId</td>
 131         </tr>
 132       </table>
 133 </div><div class="memdoc">
 134
 135 <p>The heapId used by this instance for allocating messages. </p>
 136 <p>If sending messages to a remote server, the specified heap must be compatible with the transport used for delivering messages to the remote processor. </p>
 137
 138 </div>
 139 </div>
 140 <a class="anchor" id="ab507acff4f4c36dbcad01e67a0f2b8de"></a>
 141 <div class="memitem">
 142 <div class="memproto">
 143       <table class="memname">
 144         <tr>
 145           <td class="memname">Bool RcmClient_Params::callbackNotification</td>
 146         </tr>
 147       </table>
 148 </div><div class="memdoc">
 149
 150 <p>Asynchronous callback notification support. </p>
 151 <p>When remote functions submitted with <a class="el" href="group__ti__grcm___rcm_client.html#ga950cbd891b6ae4cd59b6c9fe12fcfa5a" title="Execute a command message and use a callback for notification. ">RcmClient_execAsync()</a> complete, the given callback function is invoked. The callback function executes in the context of this RcmClient instance's callback server thread.</p>
 152 <p>This config param must be set to true when using <a class="el" href="group__ti__grcm___rcm_client.html#ga950cbd891b6ae4cd59b6c9fe12fcfa5a" title="Execute a command message and use a callback for notification. ">RcmClient_execAsync()</a> to execute remote functions.</p>
 153 <p>When set to false, the callback server thread is not created. </p>
 154
 155 </div>
 156 </div>
 157 <hr/>The documentation for this struct was generated from the following file:<ul>
 158 <li>ti/grcm/<a class="el" href="_rcm_client_8h_source.html">RcmClient.h</a></li>
 159 </ul>
 160 </div><!-- contents -->
 161 <!-- HTML footer for doxygen 1.8.9.1-->
 162 <!-- start footer part -->
 163 <hr class="footer"/><small>
 164 Copyright  2016, Texas Instruments Incorporated
 165 </small>
 166 </body>
 167 </html>