docs/API/config_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>o-du/phy: config.h File 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 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 </head>
  17 <body>
  18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19 <div id="titlearea">
  20 <table cellspacing="0" cellpadding="0">
  21  <tbody>
  22  <tr style="height: 56px;">
  23   <td id="projectalign" style="padding-left: 0.5em;">
  24    <div id="projectname">o-du/phy
  25    </div>
  26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.13 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36 </script>
  37 <script type="text/javascript" src="menudata.js"></script>
  38 <script type="text/javascript" src="menu.js"></script>
  39 <script type="text/javascript">
  40 $(function() {
  41   initMenu('',true,false,'search.php','Search');
  42   $(document).ready(function() { init_search(); });
  43 });
  44 </script>
  45 <div id="main-nav"></div>
  46 <!-- window showing the filter options -->
  47 <div id="MSearchSelectWindow"
  48      onmouseover="return searchBox.OnSearchSelectShow()"
  49      onmouseout="return searchBox.OnSearchSelectHide()"
  50      onkeydown="return searchBox.OnSearchSelectKey(event)">
  51 </div>
  52
  53 <!-- iframe showing the search results (closed by default) -->
  54 <div id="MSearchResultsWindow">
  55 <iframe src="javascript:void(0)" frameborder="0"
  56         name="MSearchResults" id="MSearchResults">
  57 </iframe>
  58 </div>
  59
  60 <div id="nav-path" class="navpath">
  61   <ul>
  62 <li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_4b76f00ffa3e05ab9c225ea6671f6b6c.html">app</a></li><li class="navelem"><a class="el" href="dir_dd7de4ccd45f8474612b8f6c09959d91.html">src</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#nested-classes">Data Structures</a> &#124;
  68 <a href="#typedef-members">Typedefs</a> &#124;
  69 <a href="#func-members">Functions</a>  </div>
  70   <div class="headertitle">
  71 <div class="title">config.h File Reference</div>  </div>
  72 </div><!--header-->
  73 <div class="contents">
  74 <div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
  75 <code>#include &lt;rte_ether.h&gt;</code><br />
  76 <code>#include &quot;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&quot;</code><br />
  77 </div><div class="textblock"><div class="dynheader">
  78 Include dependency graph for config.h:</div>
  79 <div class="dyncontent">
  80 <div class="center"><img src="config_8h__incl.png" border="0" usemap="#config_8h" alt=""/></div>
  81 <map name="config_8h" id="config_8h">
  82 <area shape="rect" id="node4" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN&#45;WG..." alt="" coords="568,80,679,107"/>
  83 </map>
  84 </div>
  85 </div><div class="textblock"><div class="dynheader">
  86 This graph shows which files directly or indirectly include this file:</div>
  87 <div class="dyncontent">
  88 <div class="center"><img src="config_8h__dep__incl.png" border="0" usemap="#config_8hdep" alt=""/></div>
  89 <map name="config_8hdep" id="config_8hdep">
  90 <area shape="rect" id="node2" href="config_8c.html" title="config.c" alt="" coords="5,155,73,181"/>
  91 <area shape="rect" id="node3" href="debug_8h.html" title="debug.h" alt="" coords="41,80,109,107"/>
  92 <area shape="rect" id="node4" href="sample-app_8c.html" title="sample&#45;app.c" alt="" coords="133,80,233,107"/>
  93 </map>
  94 </div>
  95 </div>
  96 <p><a href="config_8h_source.html">Go to the source code of this file.</a></p>
  97 <table class="memberdecls">
  98 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  99 Data Structures</h2></td></tr>
 100 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct___runtime_config.html">_RuntimeConfig</a></td></tr>
 101 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 </table><table class="memberdecls">
 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 104 Typedefs</h2></td></tr>
 105 <tr class="memitem:af57013248b2c9c128e04d2e8ce8c93c9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct___runtime_config.html">_RuntimeConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a></td></tr>
 106 <tr class="separator:af57013248b2c9c128e04d2e8ce8c93c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 </table><table class="memberdecls">
 108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 109 Functions</h2></td></tr>
 110 <tr class="memitem:add16264aa9472e4e90d1a77e086c7f93"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="config_8h.html#add16264aa9472e4e90d1a77e086c7f93">parseConfigFile</a> (char *filename, <a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a> *config)</td></tr>
 111 <tr class="separator:add16264aa9472e4e90d1a77e086c7f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 </table>
 113 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 114 <div class="textblock"><dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
 115
 116 <p class="definition">Definition in file <a class="el" href="config_8h_source.html">config.h</a>.</p>
 117 </div><h2 class="groupheader">Typedef Documentation</h2>
 118 <a id="af57013248b2c9c128e04d2e8ce8c93c9"></a>
 119 <h2 class="memtitle"><span class="permalink"><a href="#af57013248b2c9c128e04d2e8ce8c93c9">&#9670;&nbsp;</a></span>RuntimeConfig</h2>
 120
 121 <div class="memitem">
 122 <div class="memproto">
 123       <table class="memname">
 124         <tr>
 125           <td class="memname">typedef struct <a class="el" href="struct___runtime_config.html">_RuntimeConfig</a>  <a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a></td>
 126         </tr>
 127       </table>
 128 </div><div class="memdoc">
 129 <p>Run time configuration of application </p>
 130
 131 </div>
 132 </div>
 133 <h2 class="groupheader">Function Documentation</h2>
 134 <a id="add16264aa9472e4e90d1a77e086c7f93"></a>
 135 <h2 class="memtitle"><span class="permalink"><a href="#add16264aa9472e4e90d1a77e086c7f93">&#9670;&nbsp;</a></span>parseConfigFile()</h2>
 136
 137 <div class="memitem">
 138 <div class="memproto">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">int parseConfigFile </td>
 142           <td>(</td>
 143           <td class="paramtype">char *&#160;</td>
 144           <td class="paramname"><em>filename</em>, </td>
 145         </tr>
 146         <tr>
 147           <td class="paramkey"></td>
 148           <td></td>
 149           <td class="paramtype"><a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">RuntimeConfig</a> *&#160;</td>
 150           <td class="paramname"><em>config</em>&#160;</td>
 151         </tr>
 152         <tr>
 153           <td></td>
 154           <td>)</td>
 155           <td></td><td></td>
 156         </tr>
 157       </table>
 158 </div><div class="memdoc">
 159 <p>Parse application configuration file.</p>
 160 <dl class="params"><dt>Parameters</dt><dd>
 161   <table class="params">
 162     <tr><td class="paramname">filename</td><td>The name of the configuration file to be parsed. </td></tr>
 163     <tr><td class="paramname">config</td><td>The configuration structure to be filled with parsed data. </td></tr>
 164   </table>
 165   </dd>
 166 </dl>
 167
 168 <p class="definition">Definition at line <a class="el" href="config_8c_source.html#l00497">497</a> of file <a class="el" href="config_8c_source.html">config.c</a>.</p>
 169 <div class="dynheader">
 170 Here is the call graph for this function:</div>
 171 <div class="dyncontent">
 172 <div class="center"><img src="config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph.png" border="0" usemap="#config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph" alt=""/></div>
 173 <map name="config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph" id="config_8h_add16264aa9472e4e90d1a77e086c7f93_cgraph">
 174 <area shape="rect" id="node2" href="gen__test_8m.html#a14e2cbac46a5d611bf112b1f4beb7021" title="fclose" alt="" coords="167,5,224,32"/>
 175 </map>
 176 </div>
 177 <div class="dynheader">
 178 Here is the caller graph for this function:</div>
 179 <div class="dyncontent">
 180 <div class="center"><img src="config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph.png" border="0" usemap="#config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph" alt=""/></div>
 181 <map name="config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph" id="config_8h_add16264aa9472e4e90d1a77e086c7f93_icgraph">
 182 <area shape="rect" id="node2" href="sample-app_8c.html#a0ddf1224851353fc92bfbff6f499fa97" title="main" alt="" coords="167,5,217,32"/>
 183 </map>
 184 </div>
 185
 186 </div>
 187 </div>
 188 </div><!-- contents -->
 189 <!-- start footer part -->
 190 <hr class="footer"/><address class="footer"><small>
 191 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 192 <img class="footer" src="doxygen.png" alt="doxygen"/>
 193 </a> 1.8.13
 194 </small></address>
 195 </body>
 196 </html>