classhueplusplus_1_1_u_pn_p.html
6.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::UPnP Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">hueplusplus
 <span id="projectnumber">1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1_u_pn_p.html">UPnP</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhueplusplus_1_1_u_pn_p-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::UPnP Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that looks for <a class="el" href="classhueplusplus_1_1_u_pn_p.html" title="Class that looks for UPnP devices using an m-search package. ">UPnP</a> devices using an m-search package.
<a href="classhueplusplus_1_1_u_pn_p.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_u_pn_p_8h_source.html">hueplusplus/UPnP.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a882fae9e6413025dd6479e26cd06d317"><td class="memItemLeft" align="right" valign="top">std::vector< std::pair< std::string, std::string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_u_pn_p.html#a882fae9e6413025dd6479e26cd06d317">getDevices</a> (std::shared_ptr< const <a class="el" href="classhueplusplus_1_1_i_http_handler.html">IHttpHandler</a> > handler)</td></tr>
<tr class="memdesc:a882fae9e6413025dd6479e26cd06d317"><td class="mdescLeft"> </td><td class="mdescRight">Searches for <a class="el" href="classhueplusplus_1_1_u_pn_p.html" title="Class that looks for UPnP devices using an m-search package. ">UPnP</a> devices and returns all found ones. <a href="#a882fae9e6413025dd6479e26cd06d317">More...</a><br /></td></tr>
<tr class="separator:a882fae9e6413025dd6479e26cd06d317"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class that looks for <a class="el" href="classhueplusplus_1_1_u_pn_p.html" title="Class that looks for UPnP devices using an m-search package. ">UPnP</a> devices using an m-search package. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a882fae9e6413025dd6479e26cd06d317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a882fae9e6413025dd6479e26cd06d317">◆ </a></span>getDevices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< std::pair< std::string, std::string > > hueplusplus::UPnP::getDevices </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< const <a class="el" href="classhueplusplus_1_1_i_http_handler.html">IHttpHandler</a> > </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Searches for <a class="el" href="classhueplusplus_1_1_u_pn_p.html" title="Class that looks for UPnP devices using an m-search package. ">UPnP</a> devices and returns all found ones. </p>
<p>It does it by sending an m-search packet and waits for all responses. Since responses can be received multiple times this function conveniently removes all duplicates. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>HttpHandler for communication </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A vector containing pairs of address and name of all found devices </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_u_pn_p_8h_source.html">UPnP.h</a></li>
<li>src/<a class="el" href="_u_pn_p_8cpp.html">UPnP.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>