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/mbed/html/group__api__socket__types.html

Revision:
34:2616445d0823
Child:
39:a963f69cb2de
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/mbed/html/group__api__socket__types.html	Wed Nov 26 23:46:00 2014 -0800
@@ -0,0 +1,235 @@
+<!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>ACKme WiConnect Host Library</title>
+<link rel="icon" href="favicon.ico" type="image/x-icon">
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
+<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" style="font-family:verdana;">
+    <table border='0' cellpadding='0' cellspacing='0' width="98%">
+      <tr style="height:20px"><td>&nbsp;</td></tr>
+      <tr style="border-collapse: collapse; padding: 0;">
+        <td style="width:20px"></td>
+        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
+        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
+        WiConnect Host Library- API Reference Guide</td>
+        <td style="width:20px"></td>
+      </tr>
+      <tr><td>&nbsp;</td></tr>
+    </table>
+</div><!-- 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>Library&#160;Overview</span></a></li>
+      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
+      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
+      <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</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__api__socket__types.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="#nested-classes">Classes</a> &#124;
+<a href="#enum-members">Enumerations</a>  </div>
+  <div class="headertitle">
+<div class="title">Types<div class="ingroups"><a class="el" href="group__api__socket.html">Socket</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Socket Types.  
+<a href="#details">More...</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Classes</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_http_socket_args.html">wiconnect::HttpSocketArgs</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct for hold HTTP socket configuration.  <a href="structwiconnect_1_1_http_socket_args.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">wiconnect::WiconnectSocket</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection object to remote server.  <a href="classwiconnect_1_1_wiconnect_socket.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">wiconnect::WiconnectUdpServer</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">UDP Server Listening socket.  <a href="classwiconnect_1_1_wiconnect_udp_server.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
+Enumerations</h2></td></tr>
+<tr class="memitem:ga69dc55558df4c81599c5fb3dff98756d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a> { <br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da6469a1b9d8fa6448c0f6f13e0028a60e">wiconnect::SOCKET_TYPE_UNKNOWN</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756daece967eb28f8913c30bc70fa1e0e5ff9">wiconnect::SOCKET_TYPE_TCP</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da0c365c200e62d61bf22798c25ccb96b4">wiconnect::SOCKET_TYPE_TLS</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756dab1b41b1c4daf8d171414b68e9033cfbc">wiconnect::SOCKET_TYPE_UDP</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751">wiconnect::SOCKET_TYPE_HTTP</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da77625728d545a400e0eae1483225ff91">wiconnect::SOCKET_TYPE_UDPS</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da94c82597ad724e81c0bace9ed64ebc5f">wiconnect::SOCKET_TYPE_GHM</a>
+<br />
+ }</td></tr>
+<tr class="memdesc:ga69dc55558df4c81599c5fb3dff98756d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Socket type.  <a href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">More...</a><br /></td></tr>
+<tr class="separator:ga69dc55558df4c81599c5fb3dff98756d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__types.html#gadc1d6e26d4138c536bd5dce7ed4569d6">wiconnect::HttpSocketType</a> { <br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#ggadc1d6e26d4138c536bd5dce7ed4569d6afc257aa28936e9fa8a332995b5449685">wiconnect::SOCKET_HTTP_GET</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#ggadc1d6e26d4138c536bd5dce7ed4569d6ab271a5cd1775076aeb8c25fc14da12cb">wiconnect::SOCKET_HTTP_POST</a>, 
+<br />
+&#160;&#160;<a class="el" href="group__api__socket__types.html#ggadc1d6e26d4138c536bd5dce7ed4569d6a6d256a218aac67dffe66ae6c49a61236">wiconnect::SOCKET_HTTP_HEAD</a>
+<br />
+ }</td></tr>
+<tr class="memdesc:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP Socket sub-type.  <a href="group__api__socket__types.html#gadc1d6e26d4138c536bd5dce7ed4569d6">More...</a><br /></td></tr>
+<tr class="separator:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<p>Socket Types. </p>
+<h2 class="groupheader">Enumeration Type Documentation</h2>
+<a class="anchor" id="gadc1d6e26d4138c536bd5dce7ed4569d6"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="group__api__socket__types.html#gadc1d6e26d4138c536bd5dce7ed4569d6">wiconnect::HttpSocketType</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>HTTP Socket sub-type. </p>
+<table class="fieldtable">
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggadc1d6e26d4138c536bd5dce7ed4569d6afc257aa28936e9fa8a332995b5449685"></a>SOCKET_HTTP_GET&#160;</td><td class="fielddoc">
+<p>HTTP GET Request socket type. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggadc1d6e26d4138c536bd5dce7ed4569d6ab271a5cd1775076aeb8c25fc14da12cb"></a>SOCKET_HTTP_POST&#160;</td><td class="fielddoc">
+<p>HTTP POST Request socket type. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggadc1d6e26d4138c536bd5dce7ed4569d6a6d256a218aac67dffe66ae6c49a61236"></a>SOCKET_HTTP_HEAD&#160;</td><td class="fielddoc">
+<p>HTTP HEAD Request socket type. </p>
+</td></tr>
+</table>
+
+<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00354">354</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ga69dc55558df4c81599c5fb3dff98756d"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Socket type. </p>
+<table class="fieldtable">
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da6469a1b9d8fa6448c0f6f13e0028a60e"></a>SOCKET_TYPE_UNKNOWN&#160;</td><td class="fielddoc">
+<p>Socket type not known. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756daece967eb28f8913c30bc70fa1e0e5ff9"></a>SOCKET_TYPE_TCP&#160;</td><td class="fielddoc">
+<p>TCP Socket type. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da0c365c200e62d61bf22798c25ccb96b4"></a>SOCKET_TYPE_TLS&#160;</td><td class="fielddoc">
+<p>TLS Socket type. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756dab1b41b1c4daf8d171414b68e9033cfbc"></a>SOCKET_TYPE_UDP&#160;</td><td class="fielddoc">
+<p>UDP Socket type. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751"></a>SOCKET_TYPE_HTTP&#160;</td><td class="fielddoc">
+<p>HTTP Socket type,. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da77625728d545a400e0eae1483225ff91"></a>SOCKET_TYPE_UDPS&#160;</td><td class="fielddoc">
+<p>UDP Server Socket type. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="gga69dc55558df4c81599c5fb3dff98756da94c82597ad724e81c0bace9ed64ebc5f"></a>SOCKET_TYPE_GHM&#160;</td><td class="fielddoc">
+<p>goHACK.me message type </p>
+</td></tr>
+</table>
+
+<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00339">339</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
+
+</div>
+</div>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">&copy; ACKme Networks 2014</li>
+  </ul>
+</div>
+</body>
+</html>
\ No newline at end of file