| User | Revision | Line number | New 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> </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> </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 Overview</span></a></li>
|
| dan_ackme |
13:2b51f5267c92
|
47
|
<li><a href="modules.html"><span>Library API</span></a></li>
|
| dan_ackme |
13:2b51f5267c92
|
48
|
<li><a href="examples.html"><span>API 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 Reference Manual</span></a></li>
|
| dan_ackme |
13:2b51f5267c92
|
51
|
<li><a href="http://www.ack.me/WiConnect"><span>ACKme 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 List</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
73
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
74
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
75
|
<li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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="summary">
|
| dan_ackme |
11:ea484e1b7fc4
|
109
|
<a href="#pub-methods">Public Member Functions</a> |
|
| dan_ackme |
11:ea484e1b7fc4
|
110
|
<a href="classwiconnect_1_1_socket_interface-members.html">List of all members</a> </div>
|
| dan_ackme |
11:ea484e1b7fc4
|
111
|
<div class="headertitle">
|
| dan_ackme |
13:2b51f5267c92
|
112
|
<div class="title">wiconnect::SocketInterface Class Reference<div class="ingroups"><a class="el" href="group__api__socket__types.html">Types</a></div></div> </div>
|
| dan_ackme |
11:ea484e1b7fc4
|
113
|
</div><!--header-->
|
| dan_ackme |
11:ea484e1b7fc4
|
114
|
<div class="contents">
|
| dan_ackme |
11:ea484e1b7fc4
|
115
|
|
| dan_ackme |
11:ea484e1b7fc4
|
116
|
<p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server.
|
| dan_ackme |
11:ea484e1b7fc4
|
117
|
<a href="classwiconnect_1_1_socket_interface.html#details">More...</a></p>
|
| dan_ackme |
11:ea484e1b7fc4
|
118
|
|
| dan_ackme |
13:2b51f5267c92
|
119
|
<p><code>#include <<a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a>></code></p>
|
| dan_ackme |
11:ea484e1b7fc4
|
120
|
|
| dan_ackme |
11:ea484e1b7fc4
|
121
|
<p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
|
| dan_ackme |
11:ea484e1b7fc4
|
122
|
<table class="memberdecls">
|
| dan_ackme |
11:ea484e1b7fc4
|
123
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
124
|
Public Member Functions</h2></td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
125
|
<tr class="memitem:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a> ()</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
126
|
<tr class="memdesc:ga8a80d96efac7cc514fe7fc61d1878106"><td class="mdescLeft"> </td><td class="mdescRight">Close all opened sockets. <a href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
127
|
<tr class="separator:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
128
|
<tr class="memitem:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a> (<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &handler)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
129
|
<tr class="memdesc:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="mdescLeft"> </td><td class="mdescRight">Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. <a href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
130
|
<tr class="separator:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
131
|
<tr class="memitem:ga820d2fdb12d343212638e55633bd8551"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">unregisterSocketIrqHandler</a> (<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
132
|
<tr class="memdesc:ga820d2fdb12d343212638e55633bd8551"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously registered IRQ pin. <a href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
133
|
<tr class="separator:ga820d2fdb12d343212638e55633bd8551"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
134
|
<tr class="memitem:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
135
|
<tr class="memdesc:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote server. <a href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
136
|
<tr class="separator:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
137
|
<tr class="memitem:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, const char *host, uint16_t remortPort, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
138
|
<tr class="memdesc:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote TCP server. <a href="group__api__socket__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
139
|
<tr class="separator:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
140
|
<tr class="memitem:ga559cb4c055639a83fce560693dff4870"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &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
|
141
|
<tr class="memdesc:ga559cb4c055639a83fce560693dff4870"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote TLS server. <a href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
142
|
<tr class="separator:ga559cb4c055639a83fce560693dff4870"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
143
|
<tr class="memitem:ga1a7ee47642c572db433e68eaee65c44c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &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__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
144
|
<tr class="memdesc:ga1a7ee47642c572db433e68eaee65c44c"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote UDP server. <a href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
145
|
<tr class="separator:ga1a7ee47642c572db433e68eaee65c44c"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
146
|
<tr class="memitem:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, const char *url, const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
147
|
<tr class="memdesc:gab2d562c96f8f40d916fc1df1229f0e09"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote HTTP server. <a href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
148
|
<tr class="separator:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
149
|
<tr class="memitem:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
150
|
<tr class="memdesc:ga818f9fc3d616deb5ac009f001e5e611b"><td class="mdescLeft"> </td><td class="mdescRight">Issue HTTP GET Request. <a href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
151
|
<tr class="separator:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
152
|
<tr class="memitem:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
153
|
<tr class="memdesc:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="mdescLeft"> </td><td class="mdescRight">Issue HTTP POST Request. <a href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
154
|
<tr class="separator:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
155
|
<tr class="memitem:ga949cee4543c91951219652bd6282049f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, const char *url, const char *certFilename=NULL)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
156
|
<tr class="memdesc:ga949cee4543c91951219652bd6282049f"><td class="mdescLeft"> </td><td class="mdescRight">Issue HTTP HEAD Request. <a href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
157
|
<tr class="separator:ga949cee4543c91951219652bd6282049f"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
158
|
<tr class="memitem:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, const char *key, const char *value)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
159
|
<tr class="memdesc:ga2b3fd9a84f173312318e2bb22cef2004"><td class="mdescLeft"> </td><td class="mdescRight">Add HTTP header key/value pair to opened HTTP request. <a href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
160
|
<tr class="separator:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
161
|
<tr class="memitem:ga0cad302f741f3f58a2fda54b67110a70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &socket, uint32_t *statusCodePtr)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
162
|
<tr class="memdesc:ga0cad302f741f3f58a2fda54b67110a70"><td class="mdescLeft"> </td><td class="mdescRight">Get the HTTP status code from HTTP request. <a href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
163
|
<tr class="separator:ga0cad302f741f3f58a2fda54b67110a70"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
164
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
165
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
| dan_ackme |
11:ea484e1b7fc4
|
166
|
<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>
|
| dan_ackme |
13:2b51f5267c92
|
167
|
<dl class="section note"><dt>Note</dt><dd>This class is an interface to the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> class. It should never be independently instantiated or the parent of another class. </dd></dl>
|
| dan_ackme |
13:2b51f5267c92
|
168
|
|
| dan_ackme |
16:7f1d6d359787
|
169
|
<p>Definition at line <a class="el" href="_socket_interface_8h_source.html#l00051">51</a> of file <a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a>.</p>
|
| dan_ackme |
11:ea484e1b7fc4
|
170
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
| dan_ackme |
13:2b51f5267c92
|
171
|
<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/<a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
172
|
</ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
173
|
</div><!-- contents -->
|
| dan_ackme |
11:ea484e1b7fc4
|
174
|
</div><!-- doc-content -->
|
| dan_ackme |
11:ea484e1b7fc4
|
175
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
| dan_ackme |
11:ea484e1b7fc4
|
176
|
<ul>
|
| dan_ackme |
13:2b51f5267c92
|
177
|
<li class="footer">© ACKme Networks 2014</li>
|
| dan_ackme |
11:ea484e1b7fc4
|
178
|
</ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
179
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
180
|
</body>
|
| dan_ackme |
13:2b51f5267c92
|
181
|
</html> |
ACKme
AMW006-A02