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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>UPnP/DLNA plugin for VDR: cUpnpService Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>cUpnpService Class Reference</h1><!-- doxytag: class="cUpnpService" --><code>#include <<a class="el" href="upnpservice_8h-source.html">upnpservice.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for cUpnpService:</div>
<div class="dynsection">
<p><center><img src="classcUpnpService__inherit__graph.png" border="0" usemap="#cUpnpService__inherit__map" alt="Inheritance graph"></center>
<map name="cUpnpService__inherit__map">
<area shape="rect" href="classcConnectionManager.html" title="{cConnectionManager\n|- mDefaultConnection\l- mVirtualConnections\l- mSupportedProtocols\l|+ cConnectionManager()\l+ ~cConnectionManager()\l+ subscribe()\l+ execute()\l+ setError()\l- setError()\l- getProtocolInfo()\l- getCurrentConnectionIDs()\l- getCurrentConnectionInfo()\l- prepareForConnection()\l- connectionComplete()\l- createVirtualConnection()\l- destroyVirtualConnection()\l- getConnectionIDsCVS()\l}" alt="" coords="5,229,189,549"><area shape="rect" href="classcContentDirectory.html" title="{cContentDirectory\n|- mMediaDatabase\l|+ cContentDirectory()\l+ ~cContentDirectory()\l+ subscribe()\l+ execute()\l+ setError()\l- Action()\l- getSearchCapabilities()\l- getSortCapabilities()\l- getSystemUpdateID()\l- browse()\l}" alt="" coords="213,277,376,501"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcUpnpService-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcUpnpService.html#e6d3522d580e5975f5a38d5bea88e29d">subscribe</a> (Upnp_Subscription_Request *Request)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcUpnpService.html#bbffca233e6aa193eda223cb7bfc2917">execute</a> (Upnp_Action_Request *Request)=0</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcUpnpService.html#f0976057350505eca781aafcaf6b1d14">setError</a> (Upnp_Action_Request *Request, int Error)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcUpnpService.html#846cd44a1c014395278c3af339122656">parseIntegerValue</a> (IN IXML_Document *Document, IN const char *Item, OUT int *Value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcUpnpService.html#925b7a9628230ce69b803afb8fee212f">parseStringValue</a> (IN IXML_Document *Document, IN const char *Item, OUT char **Value)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="359ba19926aab21f7a2e3c77ffc7f7ea"></a><!-- doxytag: member="cUpnpService::mDeviceHandle" ref="359ba19926aab21f7a2e3c77ffc7f7ea" args="" -->
UpnpDevice_Handle </td><td class="memItemRight" valign="bottom"><a class="el" href="classcUpnpService.html#359ba19926aab21f7a2e3c77ffc7f7ea">mDeviceHandle</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the UPnP device handle of the root device <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
UPnP Service interface<p>
This is a service interface implemented by a UPnP service like CDS oder CMS<p>
It comes with some tool functions which are commonly useful for processing an event or action. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bbffca233e6aa193eda223cb7bfc2917"></a><!-- doxytag: member="cUpnpService::execute" ref="bbffca233e6aa193eda223cb7bfc2917" args="(Upnp_Action_Request *Request)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int cUpnpService::execute </td>
<td>(</td>
<td class="paramtype">Upnp_Action_Request * </td>
<td class="paramname"> <em>Request</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Executes an action<p>
This executes an action initialized by a control point. The result is stored in the first parameter.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An integer representing one of the following:<ul>
<li><b><code>UPNP_E_SUCCESS</code>,</b> if subscription was okay</li><li>or any other non null value in case of an error</li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Request</em> </td><td>Input and output parameters of an action </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Request</em> </td><td>Input and output parameters of an action </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classcConnectionManager.html#12fa6b0a9e20c3af663e3ca2b3c97dfb">cConnectionManager</a>, and <a class="el" href="classcContentDirectory.html#a0225df761512819b9c46f45b2a0f0d0">cContentDirectory</a>.</p>
</div>
</div><p>
<a class="anchor" name="846cd44a1c014395278c3af339122656"></a><!-- doxytag: member="cUpnpService::parseIntegerValue" ref="846cd44a1c014395278c3af339122656" args="(IN IXML_Document *Document, IN const char *Item, OUT int *Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cUpnpService::parseIntegerValue </td>
<td>(</td>
<td class="paramtype">IN IXML_Document * </td>
<td class="paramname"> <em>Document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IN const char * </td>
<td class="paramname"> <em>Item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OUT int * </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses an integer value<p>
This tool function parses an integer value from a given <em>IXML</em> document. It is searching for the very first occurance of the demanded item.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns<ul>
<li><b><code>0</code>,</b> if parsing was successful</li><li><b><code><0</code>,</b> if an error occured</li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Document</em> </td><td>the document, which is parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Item</em> </td><td>the demanded item </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>the value of the item </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Document</em> </td><td>the document, which is parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Item</em> </td><td>the demanded item </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>the value of the item </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="925b7a9628230ce69b803afb8fee212f"></a><!-- doxytag: member="cUpnpService::parseStringValue" ref="925b7a9628230ce69b803afb8fee212f" args="(IN IXML_Document *Document, IN const char *Item, OUT char **Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cUpnpService::parseStringValue </td>
<td>(</td>
<td class="paramtype">IN IXML_Document * </td>
<td class="paramname"> <em>Document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IN const char * </td>
<td class="paramname"> <em>Item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OUT char ** </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string value<p>
This tool function parses a string value from a given <em>IXML</em> document. It is searching for the very first occurance of the demanded item.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns<ul>
<li><b><code>0</code>,</b> if parsing was successful</li><li><b><code><0</code>,</b> if an error occured</li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Document</em> </td><td>the document, which is parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Item</em> </td><td>the demanded item </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>the value of the item </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Document</em> </td><td>the document, which is parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Item</em> </td><td>the demanded item </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>the value of the item </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f0976057350505eca781aafcaf6b1d14"></a><!-- doxytag: member="cUpnpService::setError" ref="f0976057350505eca781aafcaf6b1d14" args="(Upnp_Action_Request *Request, int Error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cUpnpService::setError </td>
<td>(</td>
<td class="paramtype">Upnp_Action_Request * </td>
<td class="paramname"> <em>Request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>Error</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets an error on an action request<p>
This function puts a error message into the action request structure according to its error code<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Request</em> </td><td>the action request, to set the error for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Error</em> </td><td>the error code of which the message should be obtained </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Request</em> </td><td>the action request, to set the error for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Error</em> </td><td>the error code of which the message should be obtained </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classcConnectionManager.html#02014a637c6cb04cbfe10b3cb4ce6d1d">cConnectionManager</a>, and <a class="el" href="classcContentDirectory.html#a3b0df304987a0f2b17733c651d5b5c6">cContentDirectory</a>.</p>
</div>
</div><p>
<a class="anchor" name="e6d3522d580e5975f5a38d5bea88e29d"></a><!-- doxytag: member="cUpnpService::subscribe" ref="e6d3522d580e5975f5a38d5bea88e29d" args="(Upnp_Subscription_Request *Request)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int cUpnpService::subscribe </td>
<td>(</td>
<td class="paramtype">Upnp_Subscription_Request * </td>
<td class="paramname"> <em>Request</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Subscribes to an event<p>
This is a callback function to register a new subscriber for an event.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An integer representing one of the following:<ul>
<li><b><code>UPNP_E_SUCCESS</code>,</b> if subscription was okay</li><li>or any other non null value in case of an error</li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Request</em> </td><td>Information about the subscription </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Request</em> </td><td>Information about the subscription </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classcConnectionManager.html#7990eba09a100e5e4ee5b01b87bcc16e">cConnectionManager</a>, and <a class="el" href="classcContentDirectory.html#17acd376a722e6e7de9ec0d4cabb707b">cContentDirectory</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>upnpcomponents/<a class="el" href="upnpservice_8h-source.html">upnpservice.h</a><li>upnpcomponents/upnpservice.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Nov 8 15:44:09 2009 for UPnP/DLNA plugin for VDR by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
