diff options
Diffstat (limited to 'docs/Driver/html/group__wifi__soc__opt.html')
| -rw-r--r-- | docs/Driver/html/group__wifi__soc__opt.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/docs/Driver/html/group__wifi__soc__opt.html b/docs/Driver/html/group__wifi__soc__opt.html new file mode 100644 index 0000000..aa15acc --- /dev/null +++ b/docs/Driver/html/group__wifi__soc__opt.html @@ -0,0 +1,236 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>WiFi Socket Option definitions</title> +<title>CMSIS-Driver: WiFi Socket Option definitions</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="cmsis.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<script type="text/javascript" src="printComponentTabs.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 46px;"> + <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">CMSIS-Driver +  <span id="projectnumber">Version 2.7.1</span> + </div> + <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<div id="CMSISnav" class="tabs1"> + <ul class="tablist"> + <script type="text/javascript"> + <!-- + writeComponentTabs.call(this); + //--> + </script> + </ul> +</div> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Usage and Description</span></a></li> + <li><a href="modules.html"><span>Reference</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('group__wifi__soc__opt.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#define-members">Macros</a> </div> + <div class="headertitle"> +<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> +</div><!--header--> +<div class="contents"> + +<p>WiFi Socket Option definitions. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:gac6fa12bbc640209a6b63f8cec282f961"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#gac6fa12bbc640209a6b63f8cec282f961">ARM_SOCKET_IO_FIONBIO</a>   1</td></tr> +<tr class="memdesc:gac6fa12bbc640209a6b63f8cec282f961"><td class="mdescLeft"> </td><td class="mdescRight">Non-blocking I/O (Set only, default = 0); opt_val = &nbio, opt_len = sizeof(nbio), nbio (integer): 0=blocking, non-blocking otherwise. <a href="#gac6fa12bbc640209a6b63f8cec282f961">More...</a><br/></td></tr> +<tr class="separator:gac6fa12bbc640209a6b63f8cec282f961"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6f76374467b5580ab0e440da1c39024e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#ga6f76374467b5580ab0e440da1c39024e">ARM_SOCKET_SO_RCVTIMEO</a>   2</td></tr> +<tr class="memdesc:ga6f76374467b5580ab0e440da1c39024e"><td class="mdescLeft"> </td><td class="mdescRight">Receive timeout in ms (default = 0); opt_val = &timeout, opt_len = sizeof(timeout) <a href="#ga6f76374467b5580ab0e440da1c39024e">More...</a><br/></td></tr> +<tr class="separator:ga6f76374467b5580ab0e440da1c39024e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad633987fb5b3478b54d3269b1b03497a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#gad633987fb5b3478b54d3269b1b03497a">ARM_SOCKET_SO_SNDTIMEO</a>   3</td></tr> +<tr class="memdesc:gad633987fb5b3478b54d3269b1b03497a"><td class="mdescLeft"> </td><td class="mdescRight">Send timeout in ms (default = 0); opt_val = &timeout, opt_len = sizeof(timeout) <a href="#gad633987fb5b3478b54d3269b1b03497a">More...</a><br/></td></tr> +<tr class="separator:gad633987fb5b3478b54d3269b1b03497a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#ga925f699a931ccbfb87eb5f3d36cbe405">ARM_SOCKET_SO_KEEPALIVE</a>   4</td></tr> +<tr class="memdesc:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="mdescLeft"> </td><td class="mdescRight">Keep-alive messages (default = 0); opt_val = &keepalive, opt_len = sizeof(keepalive), keepalive (integer): 0=disabled, enabled otherwise. <a href="#ga925f699a931ccbfb87eb5f3d36cbe405">More...</a><br/></td></tr> +<tr class="separator:ga925f699a931ccbfb87eb5f3d36cbe405"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0466a14ce32b2cc28887735b632f3e63"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__opt.html#ga0466a14ce32b2cc28887735b632f3e63">ARM_SOCKET_SO_TYPE</a>   5</td></tr> +<tr class="memdesc:ga0466a14ce32b2cc28887735b632f3e63"><td class="mdescLeft"> </td><td class="mdescRight">Socket Type (Get only); opt_val = &socket_type, opt_len = sizeof(socket_type), socket_type (integer): ARM_SOCKET_SOCK_xxx. <a href="#ga0466a14ce32b2cc28887735b632f3e63">More...</a><br/></td></tr> +<tr class="separator:ga0466a14ce32b2cc28887735b632f3e63"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<p>WiFi Socket Option definitions. </p> +<p>The WiFi Socket Option specifies the socket option for which the value is to be set or obtained. </p> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="gac6fa12bbc640209a6b63f8cec282f961"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_SOCKET_IO_FIONBIO   1</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Non-blocking I/O (Set only, default = 0); opt_val = &nbio, opt_len = sizeof(nbio), nbio (integer): 0=blocking, non-blocking otherwise. </p> +<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> + +</div> +</div> +<a class="anchor" id="ga6f76374467b5580ab0e440da1c39024e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_SOCKET_SO_RCVTIMEO   2</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Receive timeout in ms (default = 0); opt_val = &timeout, opt_len = sizeof(timeout) </p> +<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> + +</div> +</div> +<a class="anchor" id="gad633987fb5b3478b54d3269b1b03497a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_SOCKET_SO_SNDTIMEO   3</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send timeout in ms (default = 0); opt_val = &timeout, opt_len = sizeof(timeout) </p> +<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> + +</div> +</div> +<a class="anchor" id="ga925f699a931ccbfb87eb5f3d36cbe405"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_SOCKET_SO_KEEPALIVE   4</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Keep-alive messages (default = 0); opt_val = &keepalive, opt_len = sizeof(keepalive), keepalive (integer): 0=disabled, enabled otherwise. </p> +<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> + +</div> +</div> +<a class="anchor" id="ga0466a14ce32b2cc28887735b632f3e63"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_SOCKET_SO_TYPE   5</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Socket Type (Get only); opt_val = &socket_type, opt_len = sizeof(socket_type), socket_type (integer): ARM_SOCKET_SOCK_xxx. </p> +<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> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Wed Jul 10 2019 15:20:32 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved. + <!-- + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 + --> + </li> + </ul> +</div> +</body> +</html> |