]> begriffs open source - cmsis-driver-validation/blob - docs/html/group__wifi__sock__op.html
Merge branch 'develop'
[cmsis-driver-validation] / docs / html / group__wifi__sock__op.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 <title>Socket Operation</title>
7 <title>CMSIS-Driver Validation: Socket Operation</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="drv.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 <script type="text/javascript" src="printComponentTabs.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 <link href="stylsheetf" rel="stylesheet" type="text/css" />
26 </head>
27 <body>
28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <div id="titlearea">
30 <table cellspacing="0" cellpadding="0">
31  <tbody>
32  <tr style="height: 46px;">
33   <td id="projectlogo"><img alt="Logo" src="keilarm.png"/></td>
34   <td style="padding-left: 0.5em;">
35    <div id="projectname">CMSIS-Driver Validation
36    &#160;<span id="projectnumber">Version 2.0.0</span>
37    </div>
38    <div id="projectbrief">Driver Validation</div>
39   </td>
40  </tr>
41  </tbody>
42 </table>
43 </div>
44 <!-- end header part -->
45 <div id="DRVnav" class="tabs1">
46     <ul class="tablist">
47       <script type="text/javascript">
48                 <!--
49                 writeComponentTabs.call(this);
50                 //-->
51       </script>
52           </ul>
53 </div>
54 <!-- Generated by Doxygen 1.8.6 -->
55 <script type="text/javascript">
56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
57 </script>
58   <div id="navrow1" class="tabs">
59     <ul class="tablist">
60       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
61       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
62       <li><a href="modules.html"><span>Reference</span></a></li>
63       <li>
64         <div id="MSearchBox" class="MSearchBoxInactive">
65         <span class="left">
66           <img id="MSearchSelect" src="search/mag_sel.png"
67                onmouseover="return searchBox.OnSearchSelectShow()"
68                onmouseout="return searchBox.OnSearchSelectHide()"
69                alt=""/>
70           <input type="text" id="MSearchField" value="Search" accesskey="S"
71                onfocus="searchBox.OnSearchFieldFocus(true)" 
72                onblur="searchBox.OnSearchFieldFocus(false)" 
73                onkeyup="searchBox.OnSearchFieldChange(event)"/>
74           </span><span class="right">
75             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
76           </span>
77         </div>
78       </li>
79     </ul>
80   </div>
81 </div><!-- top -->
82 <div id="side-nav" class="ui-resizable side-nav-resizable">
83   <div id="nav-tree">
84     <div id="nav-tree-contents">
85       <div id="nav-sync" class="sync"></div>
86     </div>
87   </div>
88   <div id="splitbar" style="-moz-user-select:none;" 
89        class="ui-resizable-handle">
90   </div>
91 </div>
92 <script type="text/javascript">
93 $(document).ready(function(){initNavTree('group__wifi__sock__op.html','');});
94 </script>
95 <div id="doc-content">
96 <!-- window showing the filter options -->
97 <div id="MSearchSelectWindow"
98      onmouseover="return searchBox.OnSearchSelectShow()"
99      onmouseout="return searchBox.OnSearchSelectHide()"
100      onkeydown="return searchBox.OnSearchSelectKey(event)">
101 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
102
103 <!-- iframe showing the search results (closed by default) -->
104 <div id="MSearchResultsWindow">
105 <iframe src="javascript:void(0)" frameborder="0" 
106         name="MSearchResults" id="MSearchResults">
107 </iframe>
108 </div>
109
110 <div class="header">
111   <div class="summary">
112 <a href="#func-members">Functions</a>  </div>
113   <div class="headertitle">
114 <div class="title">Socket Operation<div class="ingroups"><a class="el" href="group__wifi__tests.html">Tests</a></div></div>  </div>
115 </div><!--header-->
116 <div class="contents">
117 <table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
119 Functions</h2></td></tr>
120 <tr class="memitem:ga3f689afa848ea20e279c19999f4ec733"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#ga3f689afa848ea20e279c19999f4ec733">WIFI_Transfer_Fixed</a> (void)</td></tr>
121 <tr class="memdesc:ga3f689afa848ea20e279c19999f4ec733"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Transfer_Fixed.  <a href="#ga3f689afa848ea20e279c19999f4ec733">More...</a><br/></td></tr>
122 <tr class="separator:ga3f689afa848ea20e279c19999f4ec733"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <tr class="memitem:ga40ed04ab7d8aa4e2b13e5765048e93f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#ga40ed04ab7d8aa4e2b13e5765048e93f2">WIFI_Transfer_Incremental</a> (void)</td></tr>
124 <tr class="memdesc:ga40ed04ab7d8aa4e2b13e5765048e93f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Transfer_Incremental.  <a href="#ga40ed04ab7d8aa4e2b13e5765048e93f2">More...</a><br/></td></tr>
125 <tr class="separator:ga40ed04ab7d8aa4e2b13e5765048e93f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <tr class="memitem:ga5f5bccd9e2bd0ff4d7eb82f4811b2233"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#ga5f5bccd9e2bd0ff4d7eb82f4811b2233">WIFI_Send_Fragmented</a> (void)</td></tr>
127 <tr class="memdesc:ga5f5bccd9e2bd0ff4d7eb82f4811b2233"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Send_Fragmented.  <a href="#ga5f5bccd9e2bd0ff4d7eb82f4811b2233">More...</a><br/></td></tr>
128 <tr class="separator:ga5f5bccd9e2bd0ff4d7eb82f4811b2233"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memitem:gad286800b77f175d91d9c4b42c7311051"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#gad286800b77f175d91d9c4b42c7311051">WIFI_Recv_Fragmented</a> (void)</td></tr>
130 <tr class="memdesc:gad286800b77f175d91d9c4b42c7311051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Recv_Fragmented.  <a href="#gad286800b77f175d91d9c4b42c7311051">More...</a><br/></td></tr>
131 <tr class="separator:gad286800b77f175d91d9c4b42c7311051"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:ga1ea6beecd1a175a01fa3e6cb07cfa07f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#ga1ea6beecd1a175a01fa3e6cb07cfa07f">WIFI_Test_Speed</a> (void)</td></tr>
133 <tr class="memdesc:ga1ea6beecd1a175a01fa3e6cb07cfa07f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Test_Speed.  <a href="#ga1ea6beecd1a175a01fa3e6cb07cfa07f">More...</a><br/></td></tr>
134 <tr class="separator:ga1ea6beecd1a175a01fa3e6cb07cfa07f"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:ga3176acaa3ab1f518c2e1d57348b484a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#ga3176acaa3ab1f518c2e1d57348b484a0">WIFI_Concurrent_Socket</a> (void)</td></tr>
136 <tr class="memdesc:ga3176acaa3ab1f518c2e1d57348b484a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Concurrent_Socket.  <a href="#ga3176acaa3ab1f518c2e1d57348b484a0">More...</a><br/></td></tr>
137 <tr class="separator:ga3176acaa3ab1f518c2e1d57348b484a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:gaea1b11e11f8975cafb88faa62e5c4c75"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#gaea1b11e11f8975cafb88faa62e5c4c75">WIFI_Downstream_Rate</a> (void)</td></tr>
139 <tr class="memdesc:gaea1b11e11f8975cafb88faa62e5c4c75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Downstream_Rate.  <a href="#gaea1b11e11f8975cafb88faa62e5c4c75">More...</a><br/></td></tr>
140 <tr class="separator:gaea1b11e11f8975cafb88faa62e5c4c75"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga344f942e644180492ab1f51d03b543f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sock__op.html#ga344f942e644180492ab1f51d03b543f1">WIFI_Upstream_Rate</a> (void)</td></tr>
142 <tr class="memdesc:ga344f942e644180492ab1f51d03b543f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: WIFI_Upstream_Rate.  <a href="#ga344f942e644180492ab1f51d03b543f1">More...</a><br/></td></tr>
143 <tr class="separator:ga344f942e644180492ab1f51d03b543f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 </table>
145 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
146 <p>These tests verify operation of the WiFi socket functions. </p>
147 <h2 class="groupheader">Function Documentation</h2>
148 <a class="anchor" id="ga3f689afa848ea20e279c19999f4ec733"></a>
149 <div class="memitem">
150 <div class="memproto">
151       <table class="memname">
152         <tr>
153           <td class="memname">void WIFI_Transfer_Fixed </td>
154           <td>(</td>
155           <td class="paramtype">void&#160;</td>
156           <td class="paramname"></td><td>)</td>
157           <td></td>
158         </tr>
159       </table>
160 </div><div class="memdoc">
161 <p>The test function <b>WIFI_Transfer_Fixed</b> verifies data transfer in fixed size blocks.</p>
162 <p>Stream socket test:</p>
163 <ul>
164 <li>Create stream socket</li>
165 <li>Transfer 128 blocks of 16 bytes</li>
166 <li>Transfer 32 blocks of 64 bytes</li>
167 <li>Transfer 8 blocks of 256 bytes</li>
168 <li>Transfer 2 blocks of 1024 bytes</li>
169 <li>Transfer 1 block of 2048 bytes</li>
170 <li>Close socket</li>
171 </ul>
172 <p>Datagram socket test:</p>
173 <ul>
174 <li>Create datagram socket</li>
175 <li>Transfer 128 blocks of 16 bytes</li>
176 <li>Transfer 32 blocks of 64 bytes</li>
177 <li>Transfer 8 blocks of 256 bytes</li>
178 <li>Transfer 2 blocks of 1024 bytes</li>
179 <li>Transfer 1 block of 1460 bytes</li>
180 <li>Close socket </li>
181 </ul>
182
183 </div>
184 </div>
185 <a class="anchor" id="ga40ed04ab7d8aa4e2b13e5765048e93f2"></a>
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname">void WIFI_Transfer_Incremental </td>
191           <td>(</td>
192           <td class="paramtype">void&#160;</td>
193           <td class="paramname"></td><td>)</td>
194           <td></td>
195         </tr>
196       </table>
197 </div><div class="memdoc">
198 <p>The test function <b>WIFI_Transfer_Incremental</b> verifies data transfer in ascending size blocks. Each subsequent block that the socket sends is one byte larger than the previous block.</p>
199 <p>Stream socket test:</p>
200 <ul>
201 <li>Create stream socket</li>
202 <li>Transfer 51 blocks of 1 - 50 bytes</li>
203 <li>Transfer 30 blocks of 51 - 80 bytes</li>
204 <li>Transfer 20 blocks of 81 - 100 bytes</li>
205 <li>Transfer 13 blocks of 120 - 132 bytes</li>
206 <li>Transfer 8 blocks of 252 - 259 bytes</li>
207 <li>Transfer 4 blocks of 510 - 513 bytes</li>
208 <li>Close socket</li>
209 </ul>
210 <p>Datagram socket test:</p>
211 <ul>
212 <li>Create datagram socket</li>
213 <li>Transfer 51 blocks of 1 - 50 bytes</li>
214 <li>Transfer 30 blocks of 51 - 80 bytes</li>
215 <li>Transfer 20 blocks of 81 - 100 bytes</li>
216 <li>Transfer 13 blocks of 120 - 132 bytes</li>
217 <li>Transfer 8 blocks of 252 - 259 bytes</li>
218 <li>Transfer 4 blocks of 510 - 513 bytes</li>
219 <li>Close socket </li>
220 </ul>
221
222 </div>
223 </div>
224 <a class="anchor" id="ga5f5bccd9e2bd0ff4d7eb82f4811b2233"></a>
225 <div class="memitem">
226 <div class="memproto">
227       <table class="memname">
228         <tr>
229           <td class="memname">void WIFI_Send_Fragmented </td>
230           <td>(</td>
231           <td class="paramtype">void&#160;</td>
232           <td class="paramname"></td><td>)</td>
233           <td></td>
234         </tr>
235       </table>
236 </div><div class="memdoc">
237 <p>The test function <b>WIFI_Send_Fragmented</b> verifies data transfer in chunks.</p>
238 <p>Stream socket test:</p>
239 <ul>
240 <li>Create stream socket</li>
241 <li>Send 16 blocks of 16 bytes, receive 1 block of 256 bytes</li>
242 <li>Send 16 blocks of 64 bytes, receive 1 block of 1024 bytes</li>
243 <li>Send 5 blocks of 256 bytes, receive 1 block of 1280 bytes</li>
244 <li>Send 2 blocks of 1024 bytes, receive 1 block of 2048 bytes</li>
245 <li>Close socket </li>
246 </ul>
247
248 </div>
249 </div>
250 <a class="anchor" id="gad286800b77f175d91d9c4b42c7311051"></a>
251 <div class="memitem">
252 <div class="memproto">
253       <table class="memname">
254         <tr>
255           <td class="memname">void WIFI_Recv_Fragmented </td>
256           <td>(</td>
257           <td class="paramtype">void&#160;</td>
258           <td class="paramname"></td><td>)</td>
259           <td></td>
260         </tr>
261       </table>
262 </div><div class="memdoc">
263 <p>The test function <b>WIFI_Recv_Fragmented</b> verifies data transfer in chunks.</p>
264 <p>Stream socket test:</p>
265 <ul>
266 <li>Create stream socket</li>
267 <li>Send block of 256 bytes, receive 16 blocks of 16 bytes</li>
268 <li>Send block of 1024 bytes, receive 16 blocks of 64 bytes</li>
269 <li>Send block of 1280 bytes, receive 5 blocks of 256 bytes</li>
270 <li>Send block of 2048 bytes, receive 2 blocks of 1024 bytes</li>
271 <li>Close socket </li>
272 </ul>
273
274 </div>
275 </div>
276 <a class="anchor" id="ga1ea6beecd1a175a01fa3e6cb07cfa07f"></a>
277 <div class="memitem">
278 <div class="memproto">
279       <table class="memname">
280         <tr>
281           <td class="memname">void WIFI_Test_Speed </td>
282           <td>(</td>
283           <td class="paramtype">void&#160;</td>
284           <td class="paramname"></td><td>)</td>
285           <td></td>
286         </tr>
287       </table>
288 </div><div class="memdoc">
289 <p>The test function <b>WIFI_Test_Speed</b> tests data transfer speed.</p>
290 <p>Stream socket test:</p>
291 <ul>
292 <li>Create stream socket</li>
293 <li>Transfer for 4 seconds, send and receive</li>
294 <li>Calculate transfer rate</li>
295 <li>Close socket</li>
296 </ul>
297 <p>Datagram socket test:</p>
298 <ul>
299 <li>Create datagram socket</li>
300 <li>Transfer for 4 seconds, send and receive</li>
301 <li>Calculate transfer rate</li>
302 <li>Close socket </li>
303 </ul>
304
305 </div>
306 </div>
307 <a class="anchor" id="ga3176acaa3ab1f518c2e1d57348b484a0"></a>
308 <div class="memitem">
309 <div class="memproto">
310       <table class="memname">
311         <tr>
312           <td class="memname">void WIFI_Concurrent_Socket </td>
313           <td>(</td>
314           <td class="paramtype">void&#160;</td>
315           <td class="paramname"></td><td>)</td>
316           <td></td>
317         </tr>
318       </table>
319 </div><div class="memdoc">
320 <p>The test function <b>WIFI_Concurrent_Socket</b> verifies transfer of two concurrent sockets.</p>
321 <p>Stream socket test:</p>
322 <ul>
323 <li>Create two stream sockets</li>
324 <li>Start transfer on 2nd socket with 200ms intervals</li>
325 <li>Transfer on main socket, full speed</li>
326 <li>Calculate transfer rate</li>
327 <li>Close sockets</li>
328 </ul>
329 <p>Datagram socket test:</p>
330 <ul>
331 <li>Create datagram and stream sockets</li>
332 <li>Start transfer on stream socket with 200ms intervals</li>
333 <li>Transfer on main socket, full speed</li>
334 <li>Calculate transfer rate</li>
335 <li>Close sockets <dl class="section note"><dt>Note</dt><dd>The test runs with a coherent thread, that performs an additional stream socket io. </dd></dl>
336 </li>
337 </ul>
338
339 </div>
340 </div>
341 <a class="anchor" id="gaea1b11e11f8975cafb88faa62e5c4c75"></a>
342 <div class="memitem">
343 <div class="memproto">
344       <table class="memname">
345         <tr>
346           <td class="memname">void WIFI_Downstream_Rate </td>
347           <td>(</td>
348           <td class="paramtype">void&#160;</td>
349           <td class="paramname"></td><td>)</td>
350           <td></td>
351         </tr>
352       </table>
353 </div><div class="memdoc">
354 <p>The test function <b>WIFI_Downstream_Rate</b> tests the maximum rate at which the data can be received. </p>
355
356 </div>
357 </div>
358 <a class="anchor" id="ga344f942e644180492ab1f51d03b543f1"></a>
359 <div class="memitem">
360 <div class="memproto">
361       <table class="memname">
362         <tr>
363           <td class="memname">void WIFI_Upstream_Rate </td>
364           <td>(</td>
365           <td class="paramtype">void&#160;</td>
366           <td class="paramname"></td><td>)</td>
367           <td></td>
368         </tr>
369       </table>
370 </div><div class="memdoc">
371 <p>The test function <b>WIFI_Upstream_Rate</b> tests the maximum rate at which the data can be sent. </p>
372
373 </div>
374 </div>
375 </div><!-- contents -->
376 </div><!-- doc-content -->
377 <!-- start footer part -->
378 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
379   <ul>
380     <li class="footer">Generated on Wed Jul 15 2020 10:47:11 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
381         <!--
382     <a href="http://www.doxygen.org/index.html">
383     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
384         -->
385         </li>
386   </ul>
387 </div>
388 </body>
389 </html>