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

Diff: doc/html/classwiconnect_1_1_socket_interface.html

Revision:
11:ea484e1b7fc4
Child:
13:2b51f5267c92
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/classwiconnect_1_1_socket_interface.html	Tue Aug 12 02:34:46 2014 -0700
@@ -0,0 +1,193 @@
+<!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"/>
+<meta name="generator" content="Doxygen 1.8.7"/>
+<title>WiConnect Library: wiconnect::SocketInterface Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.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>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</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: 56px;">
+  <td style="padding-left: 0.5em;">
+   <div id="projectname">WiConnect Library
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.7 -->
+<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&#160;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</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 id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
+      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&#160;Members</span></a></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('classwiconnect_1_1_socket_interface.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">&#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>
+
+<!-- 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="#pub-methods">Public Member Functions</a> &#124;
+<a href="classwiconnect_1_1_socket_interface-members.html">List of all members</a>  </div>
+  <div class="headertitle">
+<div class="title">wiconnect::SocketInterface Class Reference<div class="ingroups"><a class="el" href="group__types__socket.html">Socket API</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server.  
+ <a href="classwiconnect_1_1_socket_interface.html#details">More...</a></p>
+
+<p><code>#include &lt;SocketInterface.h&gt;</code></p>
+
+<p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8a80d96efac7cc514fe7fc61d1878106"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a> ()</td></tr>
+<tr class="memdesc:ga8a80d96efac7cc514fe7fc61d1878106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close all opened sockets. <br /></td></tr>
+<tr class="separator:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga94d1eb5407cb8b60ad366ecbe0e1b52a"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a> (<a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;handler)</td></tr>
+<tr class="memdesc:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. <br /></td></tr>
+<tr class="separator:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga820d2fdb12d343212638e55633bd8551"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga820d2fdb12d343212638e55633bd8551"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">unregisterSocketIrqHandler</a> (<a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr>
+<tr class="memdesc:ga820d2fdb12d343212638e55633bd8551"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister a previously registered IRQ pin. <br /></td></tr>
+<tr class="separator:ga820d2fdb12d343212638e55633bd8551"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf9a5b041736d79110a90716f1aaf9a6b"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">connect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, <a class="el" href="group__types__socket.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr>
+<tr class="memdesc:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote server. <br /></td></tr>
+<tr class="separator:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga74f8ac6b81d3b96a26411b4faffc6a01"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">tcpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *host, uint16_t remortPort, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
+<tr class="memdesc:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TCP server. <br /></td></tr>
+<tr class="separator:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga559cb4c055639a83fce560693dff4870"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga559cb4c055639a83fce560693dff4870"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">tlsConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *host, uint16_t remortPort, const char *certFilename=NULL, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
+<tr class="memdesc:ga559cb4c055639a83fce560693dff4870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TLS server. <br /></td></tr>
+<tr class="separator:ga559cb4c055639a83fce560693dff4870"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga1a7ee47642c572db433e68eaee65c44c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1a7ee47642c572db433e68eaee65c44c"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">udpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *host, uint16_t remortPort, uint16_t localPort=<a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
+<tr class="memdesc:ga1a7ee47642c572db433e68eaee65c44c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote UDP server. <br /></td></tr>
+<tr class="separator:ga1a7ee47642c572db433e68eaee65c44c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab2d562c96f8f40d916fc1df1229f0e09"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">httpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args)</td></tr>
+<tr class="memdesc:gab2d562c96f8f40d916fc1df1229f0e09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote HTTP server. <br /></td></tr>
+<tr class="separator:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga818f9fc3d616deb5ac009f001e5e611b"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">httpGet</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:ga818f9fc3d616deb5ac009f001e5e611b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP GET Request. <br /></td></tr>
+<tr class="separator:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaa5cb3c4b27ed0f2002e81392606a756"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">httpPost</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP POST Request. <br /></td></tr>
+<tr class="separator:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga949cee4543c91951219652bd6282049f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga949cee4543c91951219652bd6282049f"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">httpHead</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:ga949cee4543c91951219652bd6282049f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP HEAD Request. <br /></td></tr>
+<tr class="separator:ga949cee4543c91951219652bd6282049f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b3fd9a84f173312318e2bb22cef2004"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">httpAddHeader</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *key, const char *value)</td></tr>
+<tr class="memdesc:ga2b3fd9a84f173312318e2bb22cef2004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add HTTP header key/value pair to opened HTTP request. <br /></td></tr>
+<tr class="separator:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga0cad302f741f3f58a2fda54b67110a70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0cad302f741f3f58a2fda54b67110a70"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">httpGetStatus</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, uint32_t *statusCodePtr)</td></tr>
+<tr class="memdesc:ga0cad302f741f3f58a2fda54b67110a70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the HTTP status code from HTTP request. <br /></td></tr>
+<tr class="separator:ga0cad302f741f3f58a2fda54b67110a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. </p>
+</div><hr/>The documentation for this class was generated from the following file:<ul>
+<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/SocketInterface.h</li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="namespacewiconnect.html">wiconnect</a></li><li class="navelem"><a class="el" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a></li>
+    <li class="footer">Generated on Tue Aug 12 2014 02:15:25 for WiConnect Library by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
+  </ul>
+</div>
+</body>
+</html>