group__wifi__soc__opt.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  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 Option definitions</title>
  7. <title>CMSIS-Driver: WiFi Socket Option definitions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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. </head>
  26. <body>
  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: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Driver
  35. &#160;<span id="projectnumber">Version 2.8.0</span>
  36. </div>
  37. <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__wifi__soc__opt.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#define-members">Macros</a> </div>
  110. <div class="headertitle">
  111. <div class="title">WiFi Socket Option definitions<div class="ingroups"><a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>WiFi Socket Option definitions.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  118. Macros</h2></td></tr>
  119. <tr class="memitem:gac6fa12bbc640209a6b63f8cec282f961"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#gac6fa12bbc640209a6b63f8cec282f961">ARM_SOCKET_IO_FIONBIO</a>&#160;&#160;&#160;1</td></tr>
  120. <tr class="memdesc:gac6fa12bbc640209a6b63f8cec282f961"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-blocking I/O (Set only, default = 0); opt_val = &amp;nbio, opt_len = sizeof(nbio), nbio (integer): 0=blocking, non-blocking otherwise. <a href="#gac6fa12bbc640209a6b63f8cec282f961">More...</a><br/></td></tr>
  121. <tr class="separator:gac6fa12bbc640209a6b63f8cec282f961"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ga6f76374467b5580ab0e440da1c39024e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#ga6f76374467b5580ab0e440da1c39024e">ARM_SOCKET_SO_RCVTIMEO</a>&#160;&#160;&#160;2</td></tr>
  123. <tr class="memdesc:ga6f76374467b5580ab0e440da1c39024e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive timeout in ms (default = 0); opt_val = &amp;timeout, opt_len = sizeof(timeout) <a href="#ga6f76374467b5580ab0e440da1c39024e">More...</a><br/></td></tr>
  124. <tr class="separator:ga6f76374467b5580ab0e440da1c39024e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:gad633987fb5b3478b54d3269b1b03497a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#gad633987fb5b3478b54d3269b1b03497a">ARM_SOCKET_SO_SNDTIMEO</a>&#160;&#160;&#160;3</td></tr>
  126. <tr class="memdesc:gad633987fb5b3478b54d3269b1b03497a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send timeout in ms (default = 0); opt_val = &amp;timeout, opt_len = sizeof(timeout) <a href="#gad633987fb5b3478b54d3269b1b03497a">More...</a><br/></td></tr>
  127. <tr class="separator:gad633987fb5b3478b54d3269b1b03497a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#ga925f699a931ccbfb87eb5f3d36cbe405">ARM_SOCKET_SO_KEEPALIVE</a>&#160;&#160;&#160;4</td></tr>
  129. <tr class="memdesc:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="mdescLeft">&#160;</td><td class="mdescRight">Keep-alive messages (default = 0); opt_val = &amp;keepalive, opt_len = sizeof(keepalive), keepalive (integer): 0=disabled, enabled otherwise. <a href="#ga925f699a931ccbfb87eb5f3d36cbe405">More...</a><br/></td></tr>
  130. <tr class="separator:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga0466a14ce32b2cc28887735b632f3e63"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#ga0466a14ce32b2cc28887735b632f3e63">ARM_SOCKET_SO_TYPE</a>&#160;&#160;&#160;5</td></tr>
  132. <tr class="memdesc:ga0466a14ce32b2cc28887735b632f3e63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Socket Type (Get only); opt_val = &amp;socket_type, opt_len = sizeof(socket_type), socket_type (integer): ARM_SOCKET_SOCK_xxx. <a href="#ga0466a14ce32b2cc28887735b632f3e63">More...</a><br/></td></tr>
  133. <tr class="separator:ga0466a14ce32b2cc28887735b632f3e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  136. <p>WiFi Socket Option definitions. </p>
  137. <p>The WiFi Socket Option specifies the socket option for which the value is to be set or obtained. </p>
  138. <h2 class="groupheader">Macro Definition Documentation</h2>
  139. <a class="anchor" id="gac6fa12bbc640209a6b63f8cec282f961"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">#define ARM_SOCKET_IO_FIONBIO&#160;&#160;&#160;1</td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>Non-blocking I/O (Set only, default = 0); opt_val = &amp;nbio, opt_len = sizeof(nbio), nbio (integer): 0=blocking, non-blocking otherwise. </p>
  149. <p>Enables or disables the non-blocking mode for the WiFi socket. </p>
  150. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__opt.html" title="WiFi Socket Option definitions. ">WiFi Socket Option definitions</a> </dd></dl>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ga6f76374467b5580ab0e440da1c39024e"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">#define ARM_SOCKET_SO_RCVTIMEO&#160;&#160;&#160;2</td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Receive timeout in ms (default = 0); opt_val = &amp;timeout, opt_len = sizeof(timeout) </p>
  163. <p>Specifies the time limit for receiving in blocking mode. The time limit is in milliseconds. </p>
  164. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__opt.html" title="WiFi Socket Option definitions. ">WiFi Socket Option definitions</a> </dd></dl>
  165. </div>
  166. </div>
  167. <a class="anchor" id="gad633987fb5b3478b54d3269b1b03497a"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">#define ARM_SOCKET_SO_SNDTIMEO&#160;&#160;&#160;3</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Send timeout in ms (default = 0); opt_val = &amp;timeout, opt_len = sizeof(timeout) </p>
  177. <p>Specifies the time limit for sending in blocking mode. The time limit is in milliseconds. </p>
  178. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__opt.html" title="WiFi Socket Option definitions. ">WiFi Socket Option definitions</a> </dd></dl>
  179. </div>
  180. </div>
  181. <a class="anchor" id="ga925f699a931ccbfb87eb5f3d36cbe405"></a>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">#define ARM_SOCKET_SO_KEEPALIVE&#160;&#160;&#160;4</td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Keep-alive messages (default = 0); opt_val = &amp;keepalive, opt_len = sizeof(keepalive), keepalive (integer): 0=disabled, enabled otherwise. </p>
  191. <p>Enables or disables the keep-alive mode for the stream socket. </p>
  192. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__opt.html" title="WiFi Socket Option definitions. ">WiFi Socket Option definitions</a> </dd></dl>
  193. </div>
  194. </div>
  195. <a class="anchor" id="ga0466a14ce32b2cc28887735b632f3e63"></a>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">#define ARM_SOCKET_SO_TYPE&#160;&#160;&#160;5</td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Socket Type (Get only); opt_val = &amp;socket_type, opt_len = sizeof(socket_type), socket_type (integer): ARM_SOCKET_SOCK_xxx. </p>
  205. <p>Obtains the type of the Wifi socket. </p>
  206. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__opt.html" title="WiFi Socket Option definitions. ">WiFi Socket Option definitions</a> </dd></dl>
  207. </div>
  208. </div>
  209. </div><!-- contents -->
  210. </div><!-- doc-content -->
  211. <!-- start footer part -->
  212. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  213. <ul>
  214. <li class="footer">Generated on Thu Apr 9 2020 15:49:16 for CMSIS-Driver Version 2.8.0 by Arm Ltd. All rights reserved.
  215. <!--
  216. <a href="http://www.doxygen.org/index.html">
  217. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  218. -->
  219. </li>
  220. </ul>
  221. </div>
  222. </body>
  223. </html>