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/group__api__socket__tls.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 10:735194df0097 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 10:735194df0097 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 10:735194df0097 3 <head>
dan_ackme 10:735194df0097 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 10:735194df0097 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 10:735194df0097 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 15 <script type="text/javascript">
dan_ackme 10:735194df0097 16 $(document).ready(initResizable);
dan_ackme 10:735194df0097 17 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 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 10:735194df0097 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 25 </head>
dan_ackme 10:735194df0097 26 <body>
dan_ackme 10:735194df0097 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 10:735194df0097 44 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 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 10:735194df0097 49 <li><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 10:735194df0097 68 </ul>
dan_ackme 10:735194df0097 69 </div>
dan_ackme 10:735194df0097 70 </div><!-- top -->
dan_ackme 10:735194df0097 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 72 <div id="nav-tree">
dan_ackme 10:735194df0097 73 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 74 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 75 </div>
dan_ackme 10:735194df0097 76 </div>
dan_ackme 10:735194df0097 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 78 class="ui-resizable-handle">
dan_ackme 10:735194df0097 79 </div>
dan_ackme 10:735194df0097 80 </div>
dan_ackme 10:735194df0097 81 <script type="text/javascript">
dan_ackme 10:735194df0097 82 $(document).ready(function(){initNavTree('group__api__socket__tls.html','');});
dan_ackme 10:735194df0097 83 </script>
dan_ackme 10:735194df0097 84 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 85 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 86 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 90 <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 91
dan_ackme 11:ea484e1b7fc4 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 93 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 95 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 96 </iframe>
dan_ackme 11:ea484e1b7fc4 97 </div>
dan_ackme 11:ea484e1b7fc4 98
dan_ackme 10:735194df0097 99 <div class="header">
dan_ackme 11:ea484e1b7fc4 100 <div class="summary">
dan_ackme 11:ea484e1b7fc4 101 <a href="#func-members">Functions</a> </div>
dan_ackme 10:735194df0097 102 <div class="headertitle">
dan_ackme 13:2b51f5267c92 103 <div class="title">TLS Methods<div class="ingroups"><a class="el" href="group__api__socket.html">Socket</a></div></div> </div>
dan_ackme 10:735194df0097 104 </div><!--header-->
dan_ackme 10:735194df0097 105 <div class="contents">
dan_ackme 10:735194df0097 106
dan_ackme 13:2b51f5267c92 107 <p>TLS methods.
dan_ackme 10:735194df0097 108 <a href="#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 109 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 11:ea484e1b7fc4 111 Functions</h2></td></tr>
dan_ackme 13:2b51f5267c92 112 <tr class="memitem:ga559cb4c055639a83fce560693dff4870"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">wiconnect::SocketInterface::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__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
dan_ackme 13:2b51f5267c92 113 <tr class="memdesc:ga559cb4c055639a83fce560693dff4870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TLS server. <a href="#ga559cb4c055639a83fce560693dff4870">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 114 <tr class="separator:ga559cb4c055639a83fce560693dff4870"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 115 </table>
dan_ackme 11:ea484e1b7fc4 116 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 13:2b51f5267c92 117 <p>TLS methods. </p>
dan_ackme 13:2b51f5267c92 118 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 13:2b51f5267c92 119 <a class="anchor" id="ga559cb4c055639a83fce560693dff4870"></a>
dan_ackme 13:2b51f5267c92 120 <div class="memitem">
dan_ackme 13:2b51f5267c92 121 <div class="memproto">
dan_ackme 13:2b51f5267c92 122 <table class="memname">
dan_ackme 13:2b51f5267c92 123 <tr>
dan_ackme 13:2b51f5267c92 124 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::tlsConnect </td>
dan_ackme 13:2b51f5267c92 125 <td>(</td>
dan_ackme 13:2b51f5267c92 126 <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
dan_ackme 13:2b51f5267c92 127 <td class="paramname"><em>socket</em>, </td>
dan_ackme 13:2b51f5267c92 128 </tr>
dan_ackme 13:2b51f5267c92 129 <tr>
dan_ackme 13:2b51f5267c92 130 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 131 <td></td>
dan_ackme 13:2b51f5267c92 132 <td class="paramtype">const char *&#160;</td>
dan_ackme 13:2b51f5267c92 133 <td class="paramname"><em>host</em>, </td>
dan_ackme 13:2b51f5267c92 134 </tr>
dan_ackme 13:2b51f5267c92 135 <tr>
dan_ackme 13:2b51f5267c92 136 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 137 <td></td>
dan_ackme 13:2b51f5267c92 138 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 13:2b51f5267c92 139 <td class="paramname"><em>remortPort</em>, </td>
dan_ackme 13:2b51f5267c92 140 </tr>
dan_ackme 13:2b51f5267c92 141 <tr>
dan_ackme 13:2b51f5267c92 142 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 143 <td></td>
dan_ackme 13:2b51f5267c92 144 <td class="paramtype">const char *&#160;</td>
dan_ackme 13:2b51f5267c92 145 <td class="paramname"><em>certFilename</em> = <code>NULL</code>, </td>
dan_ackme 13:2b51f5267c92 146 </tr>
dan_ackme 13:2b51f5267c92 147 <tr>
dan_ackme 13:2b51f5267c92 148 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 149 <td></td>
dan_ackme 13:2b51f5267c92 150 <td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a>&#160;</td>
dan_ackme 13:2b51f5267c92 151 <td class="paramname"><em>irqPin</em> = <code>NC</code>&#160;</td>
dan_ackme 13:2b51f5267c92 152 </tr>
dan_ackme 13:2b51f5267c92 153 <tr>
dan_ackme 13:2b51f5267c92 154 <td></td>
dan_ackme 13:2b51f5267c92 155 <td>)</td>
dan_ackme 13:2b51f5267c92 156 <td></td><td></td>
dan_ackme 13:2b51f5267c92 157 </tr>
dan_ackme 13:2b51f5267c92 158 </table>
dan_ackme 13:2b51f5267c92 159 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 160
dan_ackme 13:2b51f5267c92 161 <p>Connect to remote TLS server. </p>
dan_ackme 13:2b51f5267c92 162 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 163 <table class="params">
dan_ackme 13:2b51f5267c92 164 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>TLS <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr>
dan_ackme 13:2b51f5267c92 165 <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote TLS server </td></tr>
dan_ackme 13:2b51f5267c92 166 <tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr>
dan_ackme 13:2b51f5267c92 167 <tr><td class="paramdir">[in]</td><td class="paramname">certFilename</td><td>Optional, filename of certificate on module's file system </td></tr>
dan_ackme 13:2b51f5267c92 168 <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Optional, Data available external interrupt pin. See <a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a" title="Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. ">registerSocketIrqHandler()</a> for more info </td></tr>
dan_ackme 13:2b51f5267c92 169 </table>
dan_ackme 13:2b51f5267c92 170 </dd>
dan_ackme 13:2b51f5267c92 171 </dl>
dan_ackme 13:2b51f5267c92 172 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 13:2b51f5267c92 173
dan_ackme 13:2b51f5267c92 174 </div>
dan_ackme 13:2b51f5267c92 175 </div>
dan_ackme 10:735194df0097 176 </div><!-- contents -->
dan_ackme 10:735194df0097 177 </div><!-- doc-content -->
dan_ackme 10:735194df0097 178 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 179 <ul>
dan_ackme 13:2b51f5267c92 180 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 181 </ul>
dan_ackme 10:735194df0097 182 </div>
dan_ackme 10:735194df0097 183 </body>
dan_ackme 13:2b51f5267c92 184 </html>