]> 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>WiFi Socket Operation</title>
7 <title>CMSIS-Driver Validation: WiFi 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 1.3.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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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">WiFi Socket Operation<div class="ingroups"><a class="el" href="group__wifi__funcs.html">WiFi Validation</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">Test case: 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">Test case: 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">Test case: 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">Test case: 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">Test case: 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">Test case: 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 </table>
139 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
140 <p>These tests verify operation of the WiFi socket functions. </p>
141 <h2 class="groupheader">Function Documentation</h2>
142 <a class="anchor" id="ga3176acaa3ab1f518c2e1d57348b484a0"></a>
143 <div class="memitem">
144 <div class="memproto">
145       <table class="memname">
146         <tr>
147           <td class="memname">void WIFI_Concurrent_Socket </td>
148           <td>(</td>
149           <td class="paramtype">void&#160;</td>
150           <td class="paramname"></td><td>)</td>
151           <td></td>
152         </tr>
153       </table>
154 </div><div class="memdoc">
155 <p>The test case <b>WIFI_Concurrent_Socket</b> verifies transfer of two concurrent sockets.</p>
156 <p>Stream socket test:</p>
157 <ul>
158 <li>Create two stream sockets</li>
159 <li>Start transfer on 2nd socket with 100ms intervals</li>
160 <li>Transfer on main socket, full speed</li>
161 <li>Calculate transfer rate</li>
162 <li>Close sockets</li>
163 </ul>
164 <p>Datagram socket test:</p>
165 <ul>
166 <li>Create datagram and stream sockets</li>
167 <li>Start transfer on stream socket with 100ms intervals</li>
168 <li>Transfer on main socket, full speed</li>
169 <li>Calculate transfer rate</li>
170 <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>
171 </li>
172 </ul>
173
174 </div>
175 </div>
176 <a class="anchor" id="gad286800b77f175d91d9c4b42c7311051"></a>
177 <div class="memitem">
178 <div class="memproto">
179       <table class="memname">
180         <tr>
181           <td class="memname">void WIFI_Recv_Fragmented </td>
182           <td>(</td>
183           <td class="paramtype">void&#160;</td>
184           <td class="paramname"></td><td>)</td>
185           <td></td>
186         </tr>
187       </table>
188 </div><div class="memdoc">
189 <p>The test case <b>WIFI_Recv_Fragmented</b> verifies data transfer in chunks.</p>
190 <p>Stream socket test:</p>
191 <ul>
192 <li>Create stream socket</li>
193 <li>Send block of 256 bytes, receive 16 blocks of 16 bytes</li>
194 <li>Send block of 1024 bytes, receive 16 blocks of 64 bytes</li>
195 <li>Send block of 1280 bytes, receive 5 blocks of 256 bytes</li>
196 <li>Send block of 1440 bytes, receive 2 blocks of 720 bytes</li>
197 <li>Close socket </li>
198 </ul>
199
200 </div>
201 </div>
202 <a class="anchor" id="ga5f5bccd9e2bd0ff4d7eb82f4811b2233"></a>
203 <div class="memitem">
204 <div class="memproto">
205       <table class="memname">
206         <tr>
207           <td class="memname">void WIFI_Send_Fragmented </td>
208           <td>(</td>
209           <td class="paramtype">void&#160;</td>
210           <td class="paramname"></td><td>)</td>
211           <td></td>
212         </tr>
213       </table>
214 </div><div class="memdoc">
215 <p>The test case <b>WIFI_Send_Fragmented</b> verifies data transfer in chunks.</p>
216 <p>Stream socket test:</p>
217 <ul>
218 <li>Create stream socket</li>
219 <li>Send 16 blocks of 16 bytes, receive 1 block of 256 bytes</li>
220 <li>Send 16 blocks of 64 bytes, receive 1 block of 1024 bytes</li>
221 <li>Send 5 blocks of 256 bytes, receive 1 block of 1280 bytes</li>
222 <li>Send 2 blocks of 720 bytes, receive 1 block of 1440 bytes</li>
223 <li>Close socket </li>
224 </ul>
225
226 </div>
227 </div>
228 <a class="anchor" id="ga1ea6beecd1a175a01fa3e6cb07cfa07f"></a>
229 <div class="memitem">
230 <div class="memproto">
231       <table class="memname">
232         <tr>
233           <td class="memname">void WIFI_Test_Speed </td>
234           <td>(</td>
235           <td class="paramtype">void&#160;</td>
236           <td class="paramname"></td><td>)</td>
237           <td></td>
238         </tr>
239       </table>
240 </div><div class="memdoc">
241 <p>The test case <b>WIFI_Test_Speed</b> tests data transfer speed.</p>
242 <p>Stream socket test:</p>
243 <ul>
244 <li>Create stream socket</li>
245 <li>Transfer for 4 seconds, send and receive</li>
246 <li>Calculate transfer rate</li>
247 <li>Close socket</li>
248 </ul>
249 <p>Datagram socket test:</p>
250 <ul>
251 <li>Create datagram socket</li>
252 <li>Transfer for 4 seconds, send and receive</li>
253 <li>Calculate transfer rate</li>
254 <li>Close socket </li>
255 </ul>
256
257 </div>
258 </div>
259 <a class="anchor" id="ga3f689afa848ea20e279c19999f4ec733"></a>
260 <div class="memitem">
261 <div class="memproto">
262       <table class="memname">
263         <tr>
264           <td class="memname">void WIFI_Transfer_Fixed </td>
265           <td>(</td>
266           <td class="paramtype">void&#160;</td>
267           <td class="paramname"></td><td>)</td>
268           <td></td>
269         </tr>
270       </table>
271 </div><div class="memdoc">
272 <p>The test case <b>WIFI_Transfer_Fixed</b> verifies data transfer in fixed size blocks.</p>
273 <p>Stream socket test:</p>
274 <ul>
275 <li>Create stream socket</li>
276 <li>Transfer 128 blocks of 16 bytes</li>
277 <li>Transfer 32 blocks of 64 bytes</li>
278 <li>Transfer 8 blocks of 256 bytes</li>
279 <li>Transfer 2 blocks of 1024 bytes</li>
280 <li>Transfer 1 block of 1440 bytes</li>
281 <li>Close socket</li>
282 </ul>
283 <p>Datagram socket test:</p>
284 <ul>
285 <li>Create datagram socket</li>
286 <li>Transfer 128 blocks of 16 bytes</li>
287 <li>Transfer 32 blocks of 64 bytes</li>
288 <li>Transfer 8 blocks of 256 bytes</li>
289 <li>Transfer 2 blocks of 1024 bytes</li>
290 <li>Transfer 1 block of 1460 bytes</li>
291 <li>Close socket </li>
292 </ul>
293
294 </div>
295 </div>
296 <a class="anchor" id="ga40ed04ab7d8aa4e2b13e5765048e93f2"></a>
297 <div class="memitem">
298 <div class="memproto">
299       <table class="memname">
300         <tr>
301           <td class="memname">void WIFI_Transfer_Incremental </td>
302           <td>(</td>
303           <td class="paramtype">void&#160;</td>
304           <td class="paramname"></td><td>)</td>
305           <td></td>
306         </tr>
307       </table>
308 </div><div class="memdoc">
309 <p>The test case <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>
310 <p>Stream socket test:</p>
311 <ul>
312 <li>Create stream socket</li>
313 <li>Transfer 51 blocks of 1 - 50 bytes</li>
314 <li>Transfer 30 blocks of 51 - 80 bytes</li>
315 <li>Transfer 20 blocks of 81 - 100 bytes</li>
316 <li>Transfer 13 blocks of 120 - 132 bytes</li>
317 <li>Transfer 8 blocks of 252 - 259 bytes</li>
318 <li>Transfer 4 blocks of 510 - 513 bytes</li>
319 <li>Close socket</li>
320 </ul>
321 <p>Datagram socket test:</p>
322 <ul>
323 <li>Create datagram socket</li>
324 <li>Transfer 51 blocks of 1 - 50 bytes</li>
325 <li>Transfer 30 blocks of 51 - 80 bytes</li>
326 <li>Transfer 20 blocks of 81 - 100 bytes</li>
327 <li>Transfer 13 blocks of 120 - 132 bytes</li>
328 <li>Transfer 8 blocks of 252 - 259 bytes</li>
329 <li>Transfer 4 blocks of 510 - 513 bytes</li>
330 <li>Close socket </li>
331 </ul>
332
333 </div>
334 </div>
335 </div><!-- contents -->
336 </div><!-- doc-content -->
337 <!-- start footer part -->
338 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
339   <ul>
340     <li class="footer">Generated on Fri Oct 4 2019 14:13:04 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
341         <!--
342     <a href="http://www.doxygen.org/index.html">
343     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
344         -->
345         </li>
346   </ul>
347 </div>
348 </body>
349 </html>