begriffs open source - cmsis/blob - main/Driver/group__wifi__soc__opt.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: WiFi Socket Option definitions</title>
   9 <link href="doxygen.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="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__wifi__soc__opt.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a>  </div>
 129   <div class="headertitle"><div class="title">WiFi Socket Option definitions<div class="ingroups"><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a> &raquo; <a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>WiFi Socket Option definitions.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 137 Macros</h2></td></tr>
 138 <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>
 139 <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.  <br /></td></tr>
 140 <tr class="separator:gac6fa12bbc640209a6b63f8cec282f961"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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>
 142 <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)  <br /></td></tr>
 143 <tr class="separator:ga6f76374467b5580ab0e440da1c39024e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <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)  <br /></td></tr>
 146 <tr class="separator:gad633987fb5b3478b54d3269b1b03497a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <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.  <br /></td></tr>
 149 <tr class="separator:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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>
 151 <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.  <br /></td></tr>
 152 <tr class="separator:ga0466a14ce32b2cc28887735b632f3e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <p>WiFi Socket Option definitions. </p>
 156 <p>The WiFi Socket Option specifies the socket option for which the value is to be set or obtained. </p>
 157 <h2 class="groupheader">Macro Definition Documentation</h2>
 158 <a id="gac6fa12bbc640209a6b63f8cec282f961" name="gac6fa12bbc640209a6b63f8cec282f961"></a>
 159 <h2 class="memtitle"><span class="permalink"><a href="#gac6fa12bbc640209a6b63f8cec282f961">&#9670;&#160;</a></span>ARM_SOCKET_IO_FIONBIO</h2>
 160
 161 <div class="memitem">
 162 <div class="memproto">
 163       <table class="memname">
 164         <tr>
 165           <td class="memname">#define ARM_SOCKET_IO_FIONBIO&#160;&#160;&#160;1</td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <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>
 171 <p>Enables or disables the non-blocking mode for the WiFi socket. </p><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>
 172
 173 </div>
 174 </div>
 175 <a id="ga6f76374467b5580ab0e440da1c39024e" name="ga6f76374467b5580ab0e440da1c39024e"></a>
 176 <h2 class="memtitle"><span class="permalink"><a href="#ga6f76374467b5580ab0e440da1c39024e">&#9670;&#160;</a></span>ARM_SOCKET_SO_RCVTIMEO</h2>
 177
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">#define ARM_SOCKET_SO_RCVTIMEO&#160;&#160;&#160;2</td>
 183         </tr>
 184       </table>
 185 </div><div class="memdoc">
 186
 187 <p>Receive timeout in ms (default = 0); opt_val = &amp;timeout, opt_len = sizeof(timeout) </p>
 188 <p>Specifies the time limit for receiving in blocking mode. The time limit is in milliseconds. </p><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>
 189
 190 </div>
 191 </div>
 192 <a id="gad633987fb5b3478b54d3269b1b03497a" name="gad633987fb5b3478b54d3269b1b03497a"></a>
 193 <h2 class="memtitle"><span class="permalink"><a href="#gad633987fb5b3478b54d3269b1b03497a">&#9670;&#160;</a></span>ARM_SOCKET_SO_SNDTIMEO</h2>
 194
 195 <div class="memitem">
 196 <div class="memproto">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname">#define ARM_SOCKET_SO_SNDTIMEO&#160;&#160;&#160;3</td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>Send timeout in ms (default = 0); opt_val = &amp;timeout, opt_len = sizeof(timeout) </p>
 205 <p>Specifies the time limit for sending in blocking mode. The time limit is in milliseconds. </p><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>
 206
 207 </div>
 208 </div>
 209 <a id="ga925f699a931ccbfb87eb5f3d36cbe405" name="ga925f699a931ccbfb87eb5f3d36cbe405"></a>
 210 <h2 class="memtitle"><span class="permalink"><a href="#ga925f699a931ccbfb87eb5f3d36cbe405">&#9670;&#160;</a></span>ARM_SOCKET_SO_KEEPALIVE</h2>
 211
 212 <div class="memitem">
 213 <div class="memproto">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">#define ARM_SOCKET_SO_KEEPALIVE&#160;&#160;&#160;4</td>
 217         </tr>
 218       </table>
 219 </div><div class="memdoc">
 220
 221 <p>Keep-alive messages (default = 0); opt_val = &amp;keepalive, opt_len = sizeof(keepalive), keepalive (integer): 0=disabled, enabled otherwise. </p>
 222 <p>Enables or disables the keep-alive mode for the stream socket. </p><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>
 223
 224 </div>
 225 </div>
 226 <a id="ga0466a14ce32b2cc28887735b632f3e63" name="ga0466a14ce32b2cc28887735b632f3e63"></a>
 227 <h2 class="memtitle"><span class="permalink"><a href="#ga0466a14ce32b2cc28887735b632f3e63">&#9670;&#160;</a></span>ARM_SOCKET_SO_TYPE</h2>
 228
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">#define ARM_SOCKET_SO_TYPE&#160;&#160;&#160;5</td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Socket Type (Get only); opt_val = &amp;socket_type, opt_len = sizeof(socket_type), socket_type (integer): ARM_SOCKET_SOCK_xxx. </p>
 239 <p>Obtains the type of the Wifi socket. </p><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>
 240
 241 </div>
 242 </div>
 243 </div><!-- contents -->
 244 </div><!-- doc-content -->
 245 <!-- start footer part -->
 246 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 247   <ul>
 248     <li class="footer">
 249       <script type="text/javascript">
 250         <!--
 251         writeFooter.call(this);
 252         //-->
 253       </script>
 254     </li>
 255   </ul>
 256 </div>
 257 </body>
 258 </html>