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
134
135
136
137
138
139
140
141
142
143
|
/*****************************************************************
|
| Platinum - UPnP Engine
|
| Copyright (c) 2004-2010, Plutinosoft, LLC.
| All rights reserved.
| http://www.plutinosoft.com
|
| This program is free software; you can redistribute it and/or
| modify it under the terms of the GNU General Public License
| as published by the Free Software Foundation; either version 2
| of the License, or (at your option) any later version.
|
| OEMs, ISVs, VARs and other distributors that combine and
| distribute commercially licensed software with Platinum software
| and do not wish to distribute the source code for the commercially
| licensed software under version 2, or (at your option) any later
| version, of the GNU General Public License (the "GPL") must enter
| into a commercial license agreement with Plutinosoft, LLC.
| licensing@plutinosoft.com
|
| This program is distributed in the hope that it will be useful,
| but WITHOUT ANY WARRANTY; without even the implied warranty of
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
| GNU General Public License for more details.
|
| You should have received a copy of the GNU General Public License
| along with this program; see the file LICENSE.txt. If not, write to
| the Free Software Foundation, Inc.,
| 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
| http://www.gnu.org/licenses/gpl-2.0.html
|
****************************************************************/
/** @file
UPnP Devices and ControlPoints Manager
*/
#ifndef _PLT_UPNP_H_
#define _PLT_UPNP_H_
/*----------------------------------------------------------------------
| includes
+---------------------------------------------------------------------*/
#include "PltTaskManager.h"
#include "PltCtrlPoint.h"
#include "PltDeviceHost.h"
#include "PltUtilities.h"
/*----------------------------------------------------------------------
| constants
+---------------------------------------------------------------------*/
#define PLT_DLNA_SSDP_DELAY 0.05f
#define PLT_DLNA_SSDP_DELAY_GROUP 0.2f
/*----------------------------------------------------------------------
| forward definitions
+---------------------------------------------------------------------*/
class PLT_SsdpListenTask;
/*----------------------------------------------------------------------
| PLT_UPnP class
+---------------------------------------------------------------------*/
/**
The PLT_UPnP class maintains a list of devices (PLT_DeviceHost) to advertise and/or
control points (PLT_CtrlPoint).
*/
class PLT_UPnP
{
public:
/**
Create a UPnP instance.
*/
PLT_UPnP();
~PLT_UPnP();
/**
Add and start a device inside this UPnP context.
@param device device to start.
*/
NPT_Result AddDevice(PLT_DeviceHostReference& device);
/**
Add and start a control point inside this UPnP context.
@param ctrlpoint control point to start.
*/
NPT_Result AddCtrlPoint(PLT_CtrlPointReference& ctrlpoint);
/**
Remove an existing device from this UPnP context.
@param device device to stop.
*/
NPT_Result RemoveDevice(PLT_DeviceHostReference& device);
/**
Remove an existing control point from this UPnP context.
@param ctrlpoint control point to stop.
*/
NPT_Result RemoveCtrlPoint(PLT_CtrlPointReference& ctrlpoint);
/**
Start the UPnP context and all existing devices and control points
associated with it.
*/
NPT_Result Start();
/**
Stop the UPnP context and all existing devices and control points
associated with it.
*/
NPT_Result Stop();
/**
Return the UPnP Engine state.
@return True if the UPnP engine is running.
*/
bool IsRunning() { return m_Started; }
/**
When a device and a control point are added to the same UPnP context, it is
desired that the device be not discovered by the control point. For example when
creating a combo UPnP Renderer/CtrlPoint. This methods tells the control point
to ignore devices associated with the same UPnP context.
@param ignore boolean to ignore devices in context
*/
void SetIgnoreLocalUUIDs(bool ignore) { m_IgnoreLocalUUIDs = ignore; }
private:
// members
NPT_Mutex m_Lock;
NPT_List<PLT_DeviceHostReference> m_Devices;
NPT_List<PLT_CtrlPointReference> m_CtrlPoints;
NPT_Reference<PLT_TaskManager> m_TaskManager;
// Since we can only have one socket listening on port 1900,
// we create it in here and we will attach every control points
// and devices to it when they're added
bool m_Started;
PLT_SsdpListenTask* m_SsdpListenTask;
bool m_IgnoreLocalUUIDs;
};
#endif /* _PLT_UPNP_H_ */
|
