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/_socket_interface_8h_source.html

Revision:
10:735194df0097
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/_socket_interface_8h_source.html	Mon Aug 11 21:59:00 2014 -0700
@@ -0,0 +1,133 @@
+<!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: C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/SocketInterface.h Source File</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="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 -->
+  <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="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="files.html"><span>File&#160;List</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('_socket_interface_8h_source.html','');});
+</script>
+<div id="doc-content">
+<div class="header">
+  <div class="headertitle">
+<div class="title">SocketInterface.h</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
+<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
+<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
+<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
+<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
+<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
+<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
+<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * written permission of ACKme Networks.</span></div>
+<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> */</span></div>
+<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
+<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#pragma once</span></div>
+<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
+<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;Wiconnect.h&quot;</span></div>
+<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;types/Socket.h&quot;</span></div>
+<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &quot;types/SocketIrqHandlerMap.h&quot;</span></div>
+<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
+<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
+<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">namespace </span>wiconnect {</div>
+<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div>
+<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
+<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#define SOCKET_ANY_PORT (uint16_t)0</span></div>
+<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
+<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div>
+<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
+<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">class </span>SocketInterface</div>
+<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;{</div>
+<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">public</span>:</div>
+<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    WiconnectResult closeAllSockets();</div>
+<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    WiconnectResult registerSocketIrqHandler(Pin irqPin, <span class="keyword">const</span> Callback &amp;handler);</div>
+<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    WiconnectResult unregisterSocketIrqHandler(Pin irqPin);</div>
+<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
+<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    WiconnectResult connect(Socket &amp;socket, SocketType type, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, uint16_t localPort, <span class="keyword">const</span> <span class="keywordtype">void</span> *args, Pin irqPin);</div>
+<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    WiconnectResult tcpConnect(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, Pin irqPin = NC);</div>
+<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    WiconnectResult tlsConnect(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL, Pin irqPin = NC);</div>
+<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    WiconnectResult udpConnect(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, uint16_t localPort = SOCKET_ANY_PORT, Pin irqPin = NC);</div>
+<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    WiconnectResult httpConnect(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> HttpSocketArgs *args);</div>
+<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    WiconnectResult httpGet(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keywordtype">bool</span> openOnly = <span class="keyword">false</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div>
+<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    WiconnectResult httpPost(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *contextType, <span class="keywordtype">bool</span> openOnly = <span class="keyword">true</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div>
+<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    WiconnectResult httpHead(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div>
+<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    WiconnectResult httpAddHeader(Socket &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div>
+<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    WiconnectResult httpGetStatus(Socket &amp;socket, uint32_t *statusCodePtr);</div>
+<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
+<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">protected</span>:</div>
+<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    SocketInterface(Wiconnect *wiconnect);</div>
+<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
+<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    SocketIrqHandlerMap irqHandlers;</div>
+<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
+<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">private</span>:</div>
+<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    Wiconnect *wiconnect;</div>
+<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;};</div>
+<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
+<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;}</div>
+</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2cefe8a608dd77002e2a359719ab297e.html">wiconnect</a></li><li class="navelem"><a class="el" href="dir_cd3afd97bddf83876771aca0b74624b0.html">Wiconnect</a></li><li class="navelem"><b>SocketInterface.h</b></li>
+    <li class="footer">Generated on Mon Aug 11 2014 21:58:23 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>