Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/html/classwiconnect_1_1_socket_interface-members.html@17:7268f365676b, 2014-08-23 (annotated)
- Committer:
- dan_ackme
- Date:
- Sat Aug 23 05:39:17 2014 -0700
- Revision:
- 17:7268f365676b
- Parent:
- 13:2b51f5267c92
- Child:
- 21:17bb3eddcbae
Fixes and documentation updates
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dan_ackme | 11:ea484e1b7fc4 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
dan_ackme | 11:ea484e1b7fc4 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
dan_ackme | 11:ea484e1b7fc4 | 3 | <head> |
dan_ackme | 11:ea484e1b7fc4 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
dan_ackme | 11:ea484e1b7fc4 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
dan_ackme | 13:2b51f5267c92 | 6 | <title>ACKme WiConnect Host Library</title> |
dan_ackme | 13:2b51f5267c92 | 7 | <link rel="icon" href="favicon.ico" type="image/x-icon"> |
dan_ackme | 13:2b51f5267c92 | 8 | <link rel="shortcut icon" href="favicon.ico" type="image/x-icon"> |
dan_ackme | 11:ea484e1b7fc4 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 10 | <script type="text/javascript" src="jquery.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 11 | <script type="text/javascript" src="dynsections.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 12 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 13 | <script type="text/javascript" src="resize.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 14 | <script type="text/javascript" src="navtree.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 15 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 16 | $(document).ready(initResizable); |
dan_ackme | 11:ea484e1b7fc4 | 17 | $(window).load(resizeHeight); |
dan_ackme | 11:ea484e1b7fc4 | 18 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 19 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 20 | <script type="text/javascript" src="search/search.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 21 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 22 | $(document).ready(function() { searchBox.OnSelectItem(0); }); |
dan_ackme | 11:ea484e1b7fc4 | 23 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 24 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
dan_ackme | 11:ea484e1b7fc4 | 25 | </head> |
dan_ackme | 11:ea484e1b7fc4 | 26 | <body> |
dan_ackme | 11:ea484e1b7fc4 | 27 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
dan_ackme | 13:2b51f5267c92 | 28 | <div id="titlearea" style="font-family:verdana;"> |
dan_ackme | 13:2b51f5267c92 | 29 | <table border='0' cellpadding='0' cellspacing='0' width="98%"> |
dan_ackme | 13:2b51f5267c92 | 30 | <tr style="height:20px"><td> </td></tr> |
dan_ackme | 13:2b51f5267c92 | 31 | <tr style="border-collapse: collapse; padding: 0;"> |
dan_ackme | 13:2b51f5267c92 | 32 | <td style="width:20px"></td> |
dan_ackme | 13:2b51f5267c92 | 33 | <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td> |
dan_ackme | 13:2b51f5267c92 | 34 | <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;"> |
dan_ackme | 13:2b51f5267c92 | 35 | WiConnect Host Library- API Reference Guide</td> |
dan_ackme | 13:2b51f5267c92 | 36 | <td style="width:20px"></td> |
dan_ackme | 13:2b51f5267c92 | 37 | </tr> |
dan_ackme | 13:2b51f5267c92 | 38 | <tr><td> </td></tr> |
dan_ackme | 13:2b51f5267c92 | 39 | </table> |
dan_ackme | 13:2b51f5267c92 | 40 | </div><!-- Generated by Doxygen 1.8.7 --> |
dan_ackme | 11:ea484e1b7fc4 | 41 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 42 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
dan_ackme | 11:ea484e1b7fc4 | 43 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 44 | <div id="navrow1" class="tabs"> |
dan_ackme | 11:ea484e1b7fc4 | 45 | <ul class="tablist"> |
dan_ackme | 13:2b51f5267c92 | 46 | <li><a href="index.html"><span>Library Overview</span></a></li> |
dan_ackme | 13:2b51f5267c92 | 47 | <li><a href="modules.html"><span>Library API</span></a></li> |
dan_ackme | 13:2b51f5267c92 | 48 | <li><a href="examples.html"><span>API Examples</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 49 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
dan_ackme | 13:2b51f5267c92 | 50 | <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li> |
dan_ackme | 13:2b51f5267c92 | 51 | <li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 52 | <li> |
dan_ackme | 11:ea484e1b7fc4 | 53 | <div id="MSearchBox" class="MSearchBoxInactive"> |
dan_ackme | 11:ea484e1b7fc4 | 54 | <span class="left"> |
dan_ackme | 11:ea484e1b7fc4 | 55 | <img id="MSearchSelect" src="search/mag_sel.png" |
dan_ackme | 11:ea484e1b7fc4 | 56 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 11:ea484e1b7fc4 | 57 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 11:ea484e1b7fc4 | 58 | alt=""/> |
dan_ackme | 11:ea484e1b7fc4 | 59 | <input type="text" id="MSearchField" value="Search" accesskey="S" |
dan_ackme | 11:ea484e1b7fc4 | 60 | onfocus="searchBox.OnSearchFieldFocus(true)" |
dan_ackme | 11:ea484e1b7fc4 | 61 | onblur="searchBox.OnSearchFieldFocus(false)" |
dan_ackme | 11:ea484e1b7fc4 | 62 | onkeyup="searchBox.OnSearchFieldChange(event)"/> |
dan_ackme | 11:ea484e1b7fc4 | 63 | </span><span class="right"> |
dan_ackme | 11:ea484e1b7fc4 | 64 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
dan_ackme | 11:ea484e1b7fc4 | 65 | </span> |
dan_ackme | 11:ea484e1b7fc4 | 66 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 67 | </li> |
dan_ackme | 11:ea484e1b7fc4 | 68 | </ul> |
dan_ackme | 11:ea484e1b7fc4 | 69 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 70 | <div id="navrow2" class="tabs2"> |
dan_ackme | 11:ea484e1b7fc4 | 71 | <ul class="tablist"> |
dan_ackme | 11:ea484e1b7fc4 | 72 | <li><a href="annotated.html"><span>Class List</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 73 | <li><a href="classes.html"><span>Class Index</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 74 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 75 | <li><a href="functions.html"><span>Class Members</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 76 | </ul> |
dan_ackme | 11:ea484e1b7fc4 | 77 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 78 | </div><!-- top --> |
dan_ackme | 11:ea484e1b7fc4 | 79 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
dan_ackme | 11:ea484e1b7fc4 | 80 | <div id="nav-tree"> |
dan_ackme | 11:ea484e1b7fc4 | 81 | <div id="nav-tree-contents"> |
dan_ackme | 11:ea484e1b7fc4 | 82 | <div id="nav-sync" class="sync"></div> |
dan_ackme | 11:ea484e1b7fc4 | 83 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 84 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 85 | <div id="splitbar" style="-moz-user-select:none;" |
dan_ackme | 11:ea484e1b7fc4 | 86 | class="ui-resizable-handle"> |
dan_ackme | 11:ea484e1b7fc4 | 87 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 88 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 89 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 90 | $(document).ready(function(){initNavTree('classwiconnect_1_1_socket_interface.html','');}); |
dan_ackme | 11:ea484e1b7fc4 | 91 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 92 | <div id="doc-content"> |
dan_ackme | 11:ea484e1b7fc4 | 93 | <!-- window showing the filter options --> |
dan_ackme | 11:ea484e1b7fc4 | 94 | <div id="MSearchSelectWindow" |
dan_ackme | 11:ea484e1b7fc4 | 95 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 11:ea484e1b7fc4 | 96 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 11:ea484e1b7fc4 | 97 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
dan_ackme | 11:ea484e1b7fc4 | 98 | <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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> |
dan_ackme | 11:ea484e1b7fc4 | 99 | |
dan_ackme | 11:ea484e1b7fc4 | 100 | <!-- iframe showing the search results (closed by default) --> |
dan_ackme | 11:ea484e1b7fc4 | 101 | <div id="MSearchResultsWindow"> |
dan_ackme | 11:ea484e1b7fc4 | 102 | <iframe src="javascript:void(0)" frameborder="0" |
dan_ackme | 11:ea484e1b7fc4 | 103 | name="MSearchResults" id="MSearchResults"> |
dan_ackme | 11:ea484e1b7fc4 | 104 | </iframe> |
dan_ackme | 11:ea484e1b7fc4 | 105 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 106 | |
dan_ackme | 11:ea484e1b7fc4 | 107 | <div class="header"> |
dan_ackme | 11:ea484e1b7fc4 | 108 | <div class="headertitle"> |
dan_ackme | 11:ea484e1b7fc4 | 109 | <div class="title">wiconnect::SocketInterface Member List</div> </div> |
dan_ackme | 11:ea484e1b7fc4 | 110 | </div><!--header--> |
dan_ackme | 11:ea484e1b7fc4 | 111 | <div class="contents"> |
dan_ackme | 11:ea484e1b7fc4 | 112 | |
dan_ackme | 11:ea484e1b7fc4 | 113 | <p>This is the complete list of members for <a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a>, including all inherited members.</p> |
dan_ackme | 11:ea484e1b7fc4 | 114 | <table class="directory"> |
dan_ackme | 11:ea484e1b7fc4 | 115 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 116 | <tr><td class="entry"><a class="el" href="group__api__socket__misc.html#ga037cb2813683697342fff01239c7f6f8">connect</a>(WiconnectSocket &socket, SocketType type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, Pin irqPin)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 117 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__http.html#gabed18edc44f464bac64ce8a6dc3617ec">httpAddHeader</a>(WiconnectSocket &socket, const char *key, const char *value)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 118 | <tr><td class="entry"><a class="el" href="group__api__socket__http.html#ga181a03d883f60dff0c03b65e066f0eed">httpConnect</a>(WiconnectSocket &socket, const char *url, const HttpSocketArgs *args)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 119 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__http.html#gac9b6c6a348f790cc8d43889dd72029f6">httpGet</a>(WiconnectSocket &socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 120 | <tr><td class="entry"><a class="el" href="group__api__socket__http.html#gadf59ca0783b89ee32f205e33f1bd5517">httpGetStatus</a>(WiconnectSocket &socket, uint32_t *statusCodePtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 121 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__http.html#gabcb3d69b2b1718e7ebe1ed171dec1f85">httpHead</a>(WiconnectSocket &socket, const char *url, const char *certFilename=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 122 | <tr><td class="entry"><a class="el" href="group__api__socket__http.html#ga1b6a3ebdbd164f0eb683fc335ef4d365">httpPost</a>(WiconnectSocket &socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 123 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a>(Pin irqPin, const Callback &handler)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 124 | <tr><td class="entry"><a class="el" href="group__api__socket__tcp.html#gafe15edec5f45f82a2ef82f0b0d5a6cb0">tcpConnect</a>(WiconnectSocket &socket, const char *host, uint16_t remortPort, Pin irqPin=NC)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 125 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__tls.html#gad07bdf7931fb96d4e3210367b561afb2">tlsConnect</a>(WiconnectSocket &socket, const char *host, uint16_t remortPort, const char *certFilename=NULL, Pin irqPin=NC)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 17:7268f365676b | 126 | <tr><td class="entry"><a class="el" href="group__api__socket__udp.html#gaee37b416b1e68eaefec1b49af04c87a1">udpConnect</a>(WiconnectSocket &socket, const char *host, uint16_t remortPort, uint16_t localPort=SOCKET_ANY_PORT, Pin irqPin=NC)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 127 | <tr class="even"><td class="entry"><a class="el" href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">unregisterSocketIrqHandler</a>(Pin irqPin)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 128 | </table></div><!-- contents --> |
dan_ackme | 11:ea484e1b7fc4 | 129 | </div><!-- doc-content --> |
dan_ackme | 11:ea484e1b7fc4 | 130 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
dan_ackme | 11:ea484e1b7fc4 | 131 | <ul> |
dan_ackme | 13:2b51f5267c92 | 132 | <li class="footer">© ACKme Networks 2014</li> |
dan_ackme | 11:ea484e1b7fc4 | 133 | </ul> |
dan_ackme | 11:ea484e1b7fc4 | 134 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 135 | </body> |
dan_ackme | 13:2b51f5267c92 | 136 | </html> |