add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__common__counters.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: xran_common_counters 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 <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><!-- top -->
61 <div class="header">
62   <div class="summary">
63 <a href="#pub-attribs">Data Fields</a>  </div>
64   <div class="headertitle">
65 <div class="title">xran_common_counters Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_common_counters:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__common__counters__coll__graph.png" border="0" usemap="#xran__common__counters_coll__map" alt="Collaboration graph"/></div>
74 </div>
75 <table class="memberdecls">
76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
77 Data Fields</h2></td></tr>
78 <tr class="memitem:a6094e9310d30333fffbdeec6da91007c"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__common__counters.html#a6094e9310d30333fffbdeec6da91007c">Rx_on_time</a></td></tr>
79 <tr class="separator:a6094e9310d30333fffbdeec6da91007c"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a1b07b459f4a9596d5c4a615d9e47fea2"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__common__counters.html#a1b07b459f4a9596d5c4a615d9e47fea2">Rx_early</a></td></tr>
81 <tr class="separator:a1b07b459f4a9596d5c4a615d9e47fea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a2c33ad6e68efd74811ca61eada4f52f2"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__common__counters.html#a2c33ad6e68efd74811ca61eada4f52f2">Rx_late</a></td></tr>
83 <tr class="separator:a2c33ad6e68efd74811ca61eada4f52f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:af07bbcc73027d046cf79aaeeaea95d28"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__common__counters.html#af07bbcc73027d046cf79aaeeaea95d28">Rx_corrupt</a></td></tr>
85 <tr class="separator:af07bbcc73027d046cf79aaeeaea95d28"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a98356b862ea13ddc58a1378a67c4bf8e"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__common__counters.html#a98356b862ea13ddc58a1378a67c4bf8e">Rx_pkt_dupl</a></td></tr>
87 <tr class="separator:a98356b862ea13ddc58a1378a67c4bf8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:ad863eb3e9dc4a977cce64405ec2780c7"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__common__counters.html#ad863eb3e9dc4a977cce64405ec2780c7">Total_msgs_rcvd</a></td></tr>
89 <tr class="separator:ad863eb3e9dc4a977cce64405ec2780c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 </table>
91 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
92 <div class="textblock"><p>XRAN front haul statistic counters according to Table 7 1 : Common Counters for both DL and UL </p>
93
94 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00529">529</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
95 </div><h2 class="groupheader">Field Documentation</h2>
96 <a id="af07bbcc73027d046cf79aaeeaea95d28"></a>
97 <h2 class="memtitle"><span class="permalink"><a href="#af07bbcc73027d046cf79aaeeaea95d28">&#9670;&nbsp;</a></span>Rx_corrupt</h2>
98
99 <div class="memitem">
100 <div class="memproto">
101       <table class="memname">
102         <tr>
103           <td class="memname">uint64_t Rx_corrupt</td>
104         </tr>
105       </table>
106 </div><div class="memdoc">
107 <p>Corrupt/Incorrect header packet </p>
108
109 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00533">533</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
110
111 </div>
112 </div>
113 <a id="a1b07b459f4a9596d5c4a615d9e47fea2"></a>
114 <h2 class="memtitle"><span class="permalink"><a href="#a1b07b459f4a9596d5c4a615d9e47fea2">&#9670;&nbsp;</a></span>Rx_early</h2>
115
116 <div class="memitem">
117 <div class="memproto">
118       <table class="memname">
119         <tr>
120           <td class="memname">uint64_t Rx_early</td>
121         </tr>
122       </table>
123 </div><div class="memdoc">
124 <p>Data was received too early (applies to user data reception window) </p>
125
126 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00531">531</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
127
128 </div>
129 </div>
130 <a id="a2c33ad6e68efd74811ca61eada4f52f2"></a>
131 <h2 class="memtitle"><span class="permalink"><a href="#a2c33ad6e68efd74811ca61eada4f52f2">&#9670;&nbsp;</a></span>Rx_late</h2>
132
133 <div class="memitem">
134 <div class="memproto">
135       <table class="memname">
136         <tr>
137           <td class="memname">uint64_t Rx_late</td>
138         </tr>
139       </table>
140 </div><div class="memdoc">
141 <p>Data was received too late (applies to user data reception window) </p>
142
143 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00532">532</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
144
145 </div>
146 </div>
147 <a id="a6094e9310d30333fffbdeec6da91007c"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#a6094e9310d30333fffbdeec6da91007c">&#9670;&nbsp;</a></span>Rx_on_time</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152       <table class="memname">
153         <tr>
154           <td class="memname">uint64_t Rx_on_time</td>
155         </tr>
156       </table>
157 </div><div class="memdoc">
158 <p>Data was received on time (applies to user data reception window) </p>
159
160 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00530">530</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
161
162 </div>
163 </div>
164 <a id="a98356b862ea13ddc58a1378a67c4bf8e"></a>
165 <h2 class="memtitle"><span class="permalink"><a href="#a98356b862ea13ddc58a1378a67c4bf8e">&#9670;&nbsp;</a></span>Rx_pkt_dupl</h2>
166
167 <div class="memitem">
168 <div class="memproto">
169       <table class="memname">
170         <tr>
171           <td class="memname">uint64_t Rx_pkt_dupl</td>
172         </tr>
173       </table>
174 </div><div class="memdoc">
175 <p>Duplicated packet </p>
176
177 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00534">534</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
178
179 </div>
180 </div>
181 <a id="ad863eb3e9dc4a977cce64405ec2780c7"></a>
182 <h2 class="memtitle"><span class="permalink"><a href="#ad863eb3e9dc4a977cce64405ec2780c7">&#9670;&nbsp;</a></span>Total_msgs_rcvd</h2>
183
184 <div class="memitem">
185 <div class="memproto">
186       <table class="memname">
187         <tr>
188           <td class="memname">uint64_t Total_msgs_rcvd</td>
189         </tr>
190       </table>
191 </div><div class="memdoc">
192 <p>Total messages received (on all links) </p>
193
194 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00535">535</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
195
196 </div>
197 </div>
198 <hr/>The documentation for this struct was generated from the following file:<ul>
199 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
200 </ul>
201 </div><!-- contents -->
202 <!-- start footer part -->
203 <hr class="footer"/><address class="footer"><small>
204 Generated by &#160;<a href="http://www.doxygen.org/index.html">
205 <img class="footer" src="doxygen.png" alt="doxygen"/>
206 </a> 1.8.13
207 </small></address>
208 </body>
209 </html>