| User | Revision | Line number | New 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> </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 |
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 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 |
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 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 |
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__misc.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"> </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
|
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">Miscellaneous 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>Miscellaneous socket 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: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">wiconnect::SocketInterface::closeAllSockets</a> ()</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
113
|
<tr class="memdesc:ga8a80d96efac7cc514fe7fc61d1878106"><td class="mdescLeft"> </td><td class="mdescRight">Close all opened sockets. <a href="#ga8a80d96efac7cc514fe7fc61d1878106">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
114
|
<tr class="separator:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
115
|
<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">wiconnect::SocketInterface::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
|
116
|
<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="#ga94d1eb5407cb8b60ad366ecbe0e1b52a">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
117
|
<tr class="separator:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
118
|
<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">wiconnect::SocketInterface::unregisterSocketIrqHandler</a> (<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
119
|
<tr class="memdesc:ga820d2fdb12d343212638e55633bd8551"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously registered IRQ pin. <a href="#ga820d2fdb12d343212638e55633bd8551">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
120
|
<tr class="separator:ga820d2fdb12d343212638e55633bd8551"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
121
|
<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">wiconnect::SocketInterface::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
|
122
|
<tr class="memdesc:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote server. <a href="#gaf9a5b041736d79110a90716f1aaf9a6b">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
123
|
<tr class="separator:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
124
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
125
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
| dan_ackme |
13:2b51f5267c92
|
126
|
<p>Miscellaneous socket methods. </p>
|
| dan_ackme |
13:2b51f5267c92
|
127
|
<h2 class="groupheader">Function Documentation</h2>
|
| dan_ackme |
13:2b51f5267c92
|
128
|
<a class="anchor" id="ga8a80d96efac7cc514fe7fc61d1878106"></a>
|
| dan_ackme |
13:2b51f5267c92
|
129
|
<div class="memitem">
|
| dan_ackme |
13:2b51f5267c92
|
130
|
<div class="memproto">
|
| dan_ackme |
13:2b51f5267c92
|
131
|
<table class="memname">
|
| dan_ackme |
13:2b51f5267c92
|
132
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
133
|
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::closeAllSockets </td>
|
| dan_ackme |
13:2b51f5267c92
|
134
|
<td>(</td>
|
| dan_ackme |
13:2b51f5267c92
|
135
|
<td class="paramname"></td><td>)</td>
|
| dan_ackme |
13:2b51f5267c92
|
136
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
137
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
138
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
139
|
</div><div class="memdoc">
|
| dan_ackme |
13:2b51f5267c92
|
140
|
|
| dan_ackme |
13:2b51f5267c92
|
141
|
<p>Close all opened sockets. </p>
|
| dan_ackme |
13:2b51f5267c92
|
142
|
<dl class="section note"><dt>Note</dt><dd>This closes all open sockets on the MODULE side. <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> objects on the HOST side will be still open until issuing a read/write command to the module using the socket handle.</dd></dl>
|
| dan_ackme |
13:2b51f5267c92
|
143
|
<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
|
144
|
|
| dan_ackme |
13:2b51f5267c92
|
145
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
146
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
147
|
<a class="anchor" id="gaf9a5b041736d79110a90716f1aaf9a6b"></a>
|
| dan_ackme |
13:2b51f5267c92
|
148
|
<div class="memitem">
|
| dan_ackme |
13:2b51f5267c92
|
149
|
<div class="memproto">
|
| dan_ackme |
13:2b51f5267c92
|
150
|
<table class="memname">
|
| dan_ackme |
13:2b51f5267c92
|
151
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
152
|
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::connect </td>
|
| dan_ackme |
13:2b51f5267c92
|
153
|
<td>(</td>
|
| dan_ackme |
13:2b51f5267c92
|
154
|
<td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> & </td>
|
| dan_ackme |
13:2b51f5267c92
|
155
|
<td class="paramname"><em>socket</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
156
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
157
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
158
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
159
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
160
|
<td class="paramtype"><a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> </td>
|
| dan_ackme |
13:2b51f5267c92
|
161
|
<td class="paramname"><em>type</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
162
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
163
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
164
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
165
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
166
|
<td class="paramtype">const char * </td>
|
| dan_ackme |
13:2b51f5267c92
|
167
|
<td class="paramname"><em>host</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
168
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
169
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
170
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
171
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
172
|
<td class="paramtype">uint16_t </td>
|
| dan_ackme |
13:2b51f5267c92
|
173
|
<td class="paramname"><em>remortPort</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
174
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
175
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
176
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
177
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
178
|
<td class="paramtype">uint16_t </td>
|
| dan_ackme |
13:2b51f5267c92
|
179
|
<td class="paramname"><em>localPort</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
180
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
181
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
182
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
183
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
184
|
<td class="paramtype">const void * </td>
|
| dan_ackme |
13:2b51f5267c92
|
185
|
<td class="paramname"><em>args</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
186
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
187
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
188
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
189
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
190
|
<td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
13:2b51f5267c92
|
191
|
<td class="paramname"><em>irqPin</em> </td>
|
| dan_ackme |
13:2b51f5267c92
|
192
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
193
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
194
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
195
|
<td>)</td>
|
| dan_ackme |
13:2b51f5267c92
|
196
|
<td></td><td></td>
|
| dan_ackme |
13:2b51f5267c92
|
197
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
198
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
199
|
</div><div class="memdoc">
|
| dan_ackme |
13:2b51f5267c92
|
200
|
|
| dan_ackme |
13:2b51f5267c92
|
201
|
<p>Connect to remote server. </p>
|
| dan_ackme |
13:2b51f5267c92
|
202
|
<p>This is the base method used by all the other connect methods.</p>
|
| dan_ackme |
13:2b51f5267c92
|
203
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
13:2b51f5267c92
|
204
|
<table class="params">
|
| dan_ackme |
13:2b51f5267c92
|
205
|
<tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
206
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> of connection to open </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
207
|
<tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote server </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
208
|
<tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
209
|
<tr><td class="paramdir">[in]</td><td class="paramname">localPort</td><td>The port of the module's side of the connection </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
210
|
<tr><td class="paramdir">[in]</td><td class="paramname">args</td><td>Depedent on the connection type </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
211
|
<tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>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
|
212
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
213
|
</dd>
|
| dan_ackme |
13:2b51f5267c92
|
214
|
</dl>
|
| dan_ackme |
13:2b51f5267c92
|
215
|
<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
|
216
|
|
| dan_ackme |
13:2b51f5267c92
|
217
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
218
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
219
|
<a class="anchor" id="ga94d1eb5407cb8b60ad366ecbe0e1b52a"></a>
|
| dan_ackme |
13:2b51f5267c92
|
220
|
<div class="memitem">
|
| dan_ackme |
13:2b51f5267c92
|
221
|
<div class="memproto">
|
| dan_ackme |
13:2b51f5267c92
|
222
|
<table class="memname">
|
| dan_ackme |
13:2b51f5267c92
|
223
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
224
|
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::registerSocketIrqHandler </td>
|
| dan_ackme |
13:2b51f5267c92
|
225
|
<td>(</td>
|
| dan_ackme |
13:2b51f5267c92
|
226
|
<td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
13:2b51f5267c92
|
227
|
<td class="paramname"><em>irqPin</em>, </td>
|
| dan_ackme |
13:2b51f5267c92
|
228
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
229
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
230
|
<td class="paramkey"></td>
|
| dan_ackme |
13:2b51f5267c92
|
231
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
232
|
<td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td>
|
| dan_ackme |
13:2b51f5267c92
|
233
|
<td class="paramname"><em>handler</em> </td>
|
| dan_ackme |
13:2b51f5267c92
|
234
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
235
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
236
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
237
|
<td>)</td>
|
| dan_ackme |
13:2b51f5267c92
|
238
|
<td></td><td></td>
|
| dan_ackme |
13:2b51f5267c92
|
239
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
240
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
241
|
</div><div class="memdoc">
|
| dan_ackme |
13:2b51f5267c92
|
242
|
|
| dan_ackme |
13:2b51f5267c92
|
243
|
<p>Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. </p>
|
| dan_ackme |
13:2b51f5267c92
|
244
|
<p>This should be called before calling one of the connect methods below with an irqPin parameter.</p>
|
| dan_ackme |
13:2b51f5267c92
|
245
|
<p>Basically how this works is:</p><ol type="1">
|
| dan_ackme |
13:2b51f5267c92
|
246
|
<li>The supplied irqPin is configured as an external interrupt pin.</li>
|
| dan_ackme |
13:2b51f5267c92
|
247
|
<li>A connection is opened and configured with the same irqPin. This irqPin physically connected to a GPIO on the WiFi module.</li>
|
| dan_ackme |
13:2b51f5267c92
|
248
|
<li>When the WiFi module has data to send to the HOST it asserts the irqPin.</li>
|
| dan_ackme |
13:2b51f5267c92
|
249
|
<li>The irqPin interrupt executes and calls the supplied handler.</li>
|
| dan_ackme |
13:2b51f5267c92
|
250
|
<li><p class="startli">The handler should notify the HOST that the given irqPin has triggered and have the associated socket read data from the module.</p>
|
| dan_ackme |
13:2b51f5267c92
|
251
|
<dl class="section note"><dt>Note</dt><dd>arg1 of the handler contains the irqPin</dd></dl>
|
| dan_ackme |
13:2b51f5267c92
|
252
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
13:2b51f5267c92
|
253
|
<table class="params">
|
| dan_ackme |
13:2b51f5267c92
|
254
|
<tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>The HOST pin to configure as an external interrupt. This pin should be physically connected to a module GPIO. </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
255
|
<tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> to be executed with the external irqPin interrupt triggers </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
256
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
257
|
</dd>
|
| dan_ackme |
13:2b51f5267c92
|
258
|
</dl>
|
| dan_ackme |
13:2b51f5267c92
|
259
|
<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
|
260
|
</li>
|
| dan_ackme |
13:2b51f5267c92
|
261
|
</ol>
|
| dan_ackme |
13:2b51f5267c92
|
262
|
|
| dan_ackme |
13:2b51f5267c92
|
263
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
264
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
265
|
<a class="anchor" id="ga820d2fdb12d343212638e55633bd8551"></a>
|
| dan_ackme |
13:2b51f5267c92
|
266
|
<div class="memitem">
|
| dan_ackme |
13:2b51f5267c92
|
267
|
<div class="memproto">
|
| dan_ackme |
13:2b51f5267c92
|
268
|
<table class="memname">
|
| dan_ackme |
13:2b51f5267c92
|
269
|
<tr>
|
| dan_ackme |
13:2b51f5267c92
|
270
|
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::unregisterSocketIrqHandler </td>
|
| dan_ackme |
13:2b51f5267c92
|
271
|
<td>(</td>
|
| dan_ackme |
13:2b51f5267c92
|
272
|
<td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
13:2b51f5267c92
|
273
|
<td class="paramname"><em>irqPin</em></td><td>)</td>
|
| dan_ackme |
13:2b51f5267c92
|
274
|
<td></td>
|
| dan_ackme |
13:2b51f5267c92
|
275
|
</tr>
|
| dan_ackme |
13:2b51f5267c92
|
276
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
277
|
</div><div class="memdoc">
|
| dan_ackme |
13:2b51f5267c92
|
278
|
|
| dan_ackme |
13:2b51f5267c92
|
279
|
<p>Unregister a previously registered IRQ pin. </p>
|
| dan_ackme |
13:2b51f5267c92
|
280
|
<p>This disables the given irqPin as an external interrupt. Refer to <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 information.</p>
|
| dan_ackme |
13:2b51f5267c92
|
281
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
13:2b51f5267c92
|
282
|
<table class="params">
|
| dan_ackme |
13:2b51f5267c92
|
283
|
<tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>The HOST pin to unregister </td></tr>
|
| dan_ackme |
13:2b51f5267c92
|
284
|
</table>
|
| dan_ackme |
13:2b51f5267c92
|
285
|
</dd>
|
| dan_ackme |
13:2b51f5267c92
|
286
|
</dl>
|
| dan_ackme |
13:2b51f5267c92
|
287
|
<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
|
288
|
|
| dan_ackme |
13:2b51f5267c92
|
289
|
</div>
|
| dan_ackme |
13:2b51f5267c92
|
290
|
</div>
|
| dan_ackme |
10:735194df0097
|
291
|
</div><!-- contents -->
|
| dan_ackme |
10:735194df0097
|
292
|
</div><!-- doc-content -->
|
| dan_ackme |
10:735194df0097
|
293
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
| dan_ackme |
10:735194df0097
|
294
|
<ul>
|
| dan_ackme |
13:2b51f5267c92
|
295
|
<li class="footer">© ACKme Networks 2014</li>
|
| dan_ackme |
10:735194df0097
|
296
|
</ul>
|
| dan_ackme |
10:735194df0097
|
297
|
</div>
|
| dan_ackme |
10:735194df0097
|
298
|
</body>
|
| dan_ackme |
13:2b51f5267c92
|
299
|
</html> |
ACKme
AMW006-A02