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