ACKme / WiConnect

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@13:2b51f5267c92, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 03:14:30 2014 -0700
Revision:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
17:7268f365676b
doc updates

Who changed what in which revision?

UserRevisionLine numberNew 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>&nbsp;</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>&nbsp;</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&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;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&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;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&#160;List</span></a></li>
dan_ackme 11:ea484e1b7fc4 73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 11:ea484e1b7fc4 74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 11:ea484e1b7fc4 75 <li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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 11:ea484e1b7fc4 116 <tr><td class="entry"><a class="el" href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">connect</a>(Socket &amp;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 11:ea484e1b7fc4 117 <tr class="even"><td class="entry"><a class="el" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">httpAddHeader</a>(Socket &amp;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 11:ea484e1b7fc4 118 <tr><td class="entry"><a class="el" href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">httpConnect</a>(Socket &amp;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 11:ea484e1b7fc4 119 <tr class="even"><td class="entry"><a class="el" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">httpGet</a>(Socket &amp;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 11:ea484e1b7fc4 120 <tr><td class="entry"><a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">httpGetStatus</a>(Socket &amp;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 11:ea484e1b7fc4 121 <tr class="even"><td class="entry"><a class="el" href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">httpHead</a>(Socket &amp;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 11:ea484e1b7fc4 122 <tr><td class="entry"><a class="el" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">httpPost</a>(Socket &amp;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 &amp;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 11:ea484e1b7fc4 124 <tr><td class="entry"><a class="el" href="group__api__socket__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">tcpConnect</a>(Socket &amp;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 11:ea484e1b7fc4 125 <tr class="even"><td class="entry"><a class="el" href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">tlsConnect</a>(Socket &amp;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 11:ea484e1b7fc4 126 <tr><td class="entry"><a class="el" href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">udpConnect</a>(Socket &amp;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">&copy; 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>