libUPnP  1.14.0
upnpapi.h
Go to the documentation of this file.
1 /*******************************************************************************
2  *
3  * Copyright (c) 2000-2003 Intel Corporation
4  * All rights reserved.
5  * Copyright (C) 2011-2012 France Telecom All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  * * Neither name of Intel Corporation nor the names of its contributors
16  * may be used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
27  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  ******************************************************************************/
32 
33 
34 #ifndef UPNPAPI_H
35 #define UPNPAPI_H
36 
37 
43 #include "client_table.h"
44 #include "upnp.h"
45 #include "VirtualDir.h" /* for struct VirtualDirCallbacks */
46 
47 
48 #define MAX_INTERFACES 256
49 
50 #define DEV_LIMIT 200
51 
52 #define DEFAULT_MX 5
53 
54 #define DEFAULT_MAXAGE 1800
55 
56 #define DEFAULT_SOAP_CONTENT_LENGTH 16000
57 #define MAX_SOAP_CONTENT_LENGTH (size_t)32000
58 
59 #define NUM_HANDLE 200
60 
61 extern size_t g_maxContentLength;
62 extern int g_UpnpSdkEQMaxLen;
63 extern int g_UpnpSdkEQMaxAge;
64 
65 /* 30-second timeout */
66 #define UPNP_TIMEOUT 30
67 
68 typedef enum {HND_INVALID=-1,HND_CLIENT,HND_DEVICE} Upnp_Handle_Type;
69 
70 /* Data to be stored in handle table for */
72 {
74  Upnp_Handle_Type HType;
78  char *Cookie;
81 
82  /* Device Only */
83 #ifdef INCLUDE_DEVICE_APIS
84 
85  char DescURL[LINE_SIZE];
88  char LowerDescURL[LINE_SIZE];
90  char DescXML[LINE_SIZE];
91  /* Advertisement timeout */
92  int MaxAge;
93  /* Power State as defined by UPnP Low Power. */
94  int PowerState;
95  /* Sleep Period as defined by UPnP Low Power. */
96  int SleepPeriod;
97  /* Registration State as defined by UPnP Low Power. */
98  int RegistrationState;
112  int DeviceAf;
113 #endif
114 
115  /* Client only */
116 #ifdef INCLUDE_CLIENT_APIS
117 
121 #endif
122 };
123 
124 extern ithread_rwlock_t GlobalHndRWLock;
125 
131 Upnp_Handle_Type GetHandleInfo(
133  int Hnd,
135  struct Handle_Info **HndInfo);
136 
137 
138 #define HandleLock() HandleWriteLock()
139 
140 
141 #define HandleWriteLock() \
142  UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Trying a write lock\n"); \
143  ithread_rwlock_wrlock(&GlobalHndRWLock); \
144  UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Write lock acquired\n");
145 
146 
147 #define HandleReadLock() \
148  UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Trying a read lock\n"); \
149  ithread_rwlock_rdlock(&GlobalHndRWLock); \
150  UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Read lock acquired\n");
151 
152 
153 #define HandleUnlock() \
154  UpnpPrintf(UPNP_INFO, API,__FILE__, __LINE__, "Trying Unlock\n"); \
155  ithread_rwlock_unlock(&GlobalHndRWLock); \
156  UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Unlocked rwlock\n");
157 
158 
166 Upnp_Handle_Type GetClientHandleInfo(
168  int *client_handle_out,
170  struct Handle_Info **HndInfo);
179 Upnp_Handle_Type GetDeviceHandleInfo(
181  UpnpDevice_Handle start,
183  int AddressFamily,
185  int *device_handle_out,
187  struct Handle_Info **HndInfo);
188 
196 Upnp_Handle_Type GetDeviceHandleInfoForPath(
198  const char *path,
200  int AddressFamily,
202  int *device_handle_out,
204  struct Handle_Info **HndInfo,
206  service_info **serv_info
207  );
208 
209 
210 extern char gIF_NAME[LINE_SIZE];
211 extern char gIF_IPV4[INET_ADDRSTRLEN];
212 extern char gIF_IPV4_NETMASK[INET_ADDRSTRLEN];
213 extern char gIF_IPV6[INET6_ADDRSTRLEN];
214 extern unsigned gIF_IPV6_PREFIX_LENGTH;
215 
216 extern char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN];
217 extern unsigned gIF_IPV6_ULA_GUA_PREFIX_LENGTH;
218 
219 extern unsigned gIF_INDEX;
220 
221 
222 extern unsigned short LOCAL_PORT_V4;
223 extern unsigned short LOCAL_PORT_V6;
224 
225 
228 
229 
234 
235 
236 typedef enum {
237  SUBSCRIBE,
238  UNSUBSCRIBE,
239  DK_NOTIFY,
240  QUERY,
241  ACTION,
242  STATUS,
243  DEVDESCRIPTION,
244  SERVDESCRIPTION,
245  MINI,
246  RENEW
247 } UpnpFunName;
248 
249 
251 {
252  UpnpFunName FunName;
253  int Handle;
254  int TimeOut;
255  char VarName[NAME_SIZE];
256  char NewVal[NAME_SIZE];
257  char DevType[NAME_SIZE];
258  char DevId[NAME_SIZE];
259  char ServiceType[NAME_SIZE];
260  char ServiceVer[NAME_SIZE];
261  char Url[NAME_SIZE];
262  Upnp_SID SubsId;
263  char *Cookie;
264  Upnp_FunPtr Fun;
265  IXML_Document *Header;
266  IXML_Document *Act;
267  struct DevDesc *Devdesc;
268 };
269 
270 
273 
274 
275 typedef enum {
276  WEB_SERVER_DISABLED,
277  WEB_SERVER_ENABLED
278 } WebServerState;
279 
280 
281 #define E_HTTP_SYNTAX -6
282 
283 
303 int UpnpGetIfInfo(
305  const char *IfName);
306 
307 
308 void UpnpThreadDistribution(struct UpnpNonblockParam * Param);
309 
310 
315 void AutoAdvertise(
317  void *input);
318 
319 
325 int PrintHandleInfo(
327  UpnpClient_Handle Hnd);
328 
329 
330 extern WebServerState bWebServerState;
331 
332 
333 #endif /* UPNPAPI_H */
334 
Upnp_FunPtr Callback
Definition: upnpapi.h:76
int UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient.
Definition: upnp.h:429
IXML_Document * DescDocument
Definition: upnpapi.h:100
size_t g_maxContentLength
Definition: upnpapi.c:176
char DescURL[LINE_SIZE]
Definition: upnpapi.h:85
Definition: service_table.h:71
Definition: TimerThread.h:67
unsigned gIF_IPV6_PREFIX_LENGTH
Definition: upnpapi.c:146
Upnp_Handle_Type GetDeviceHandleInfo(UpnpDevice_Handle start, int AddressFamily, int *device_handle_out, struct Handle_Info **HndInfo)
Retrieves the device handle and information of the first device of the address family specified...
Definition: upnpapi.c:4247
Definition: upnpapi.h:250
IXML_NodeList * DeviceList
Definition: upnpapi.h:102
Upnp_Handle_Type GetHandleInfo(int Hnd, struct Handle_Info **HndInfo)
Get handle information.
Definition: upnpapi.c:4324
char LowerDescURL[LINE_SIZE]
Definition: upnpapi.h:88
int g_UpnpSdkEQMaxAge
Definition: upnpapi.c:192
Upnp_Handle_Type HType
Definition: upnpapi.h:74
LinkedList SsdpSearchList
Definition: upnpapi.h:120
Definition: VirtualDir.h:11
ThreadPool gSendThreadPool
Definition: upnpapi.c:121
IXML_NodeList * ServiceList
Definition: upnpapi.h:104
WebServerState bWebServerState
Definition: upnpapi.c:130
GenlibClientSubscription * ClientSubList
Definition: upnpapi.h:118
Upnp_SID gUpnpSdkNLSuuid
int PrintHandleInfo(UpnpClient_Handle Hnd)
Print handle info.
Definition: upnpapi.c:4360
char gIF_IPV6[INET6_ADDRSTRLEN]
Definition: upnpapi.c:143
Upnp_Handle_Type GetDeviceHandleInfoForPath(const char *path, int AddressFamily, int *device_handle_out, struct Handle_Info **HndInfo, service_info **serv_info)
Retrieves the device handle and information of the first device of the address family specified...
Definition: upnpapi.c:4284
int MaxSubscriptionTimeOut
Definition: upnpapi.h:110
A thread pool similar to the thread pool in the UPnP SDK.
Definition: ThreadPool.h:215
unsigned short LOCAL_PORT_V6
Definition: upnpapi.c:162
TimerThread gTimerThread
Definition: upnpapi.c:118
int aliasInstalled
Definition: upnpapi.h:80
Definition: service_table.h:89
char gIF_IPV4_NETMASK[INET_ADDRSTRLEN]
Definition: upnpapi.c:139
void AutoAdvertise(void *input)
This function is a timer thread scheduled by UpnpSendAdvertisement to the send advetisement again...
Definition: upnpapi.c:4399
unsigned short LOCAL_PORT_V4
Definition: upnpapi.c:159
unsigned gIF_IPV6_ULA_GUA_PREFIX_LENGTH
Definition: upnpapi.c:153
void UpnpThreadDistribution(struct UpnpNonblockParam *Param)
Schedule async functions in threadpool.
Definition: upnpapi.c:4115
char gIF_NAME[LINE_SIZE]
Definition: upnpapi.c:133
char gIF_IPV4[INET_ADDRSTRLEN]
Definition: upnpapi.c:136
int UpnpDevice_Handle
Returned when a device application registers with UpnpRegisterRootDevice, UpnpRegisterRootDevice2, UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4.
Definition: upnp.h:439
ithread_rwlock_t GlobalHndRWLock
Definition: upnpapi.c:109
Upnp_Handle_Type GetClientHandleInfo(int *client_handle_out, struct Handle_Info **HndInfo)
Get client handle info.
Definition: upnpapi.c:4227
service_table ServiceTable
Definition: upnpapi.h:106
Data structure representing a list of nodes.
Definition: ixml.h:202
virtualDirList * pVirtualDirList
Definition: upnpapi.c:101
unsigned gIF_INDEX
Definition: upnpapi.c:156
struct VirtualDirCallbacks virtualDirCallback
Definition: upnpapi.c:98
int(* Upnp_FunPtr)(Upnp_EventType EventType, const void *Event, void *Cookie)
Definition: Callback.h:145
char * Cookie
Definition: upnpapi.h:78
int MaxSubscriptions
Definition: upnpapi.h:108
int DeviceAf
Definition: upnpapi.h:112
int UpnpGetIfInfo(const char *IfName)
Retrieve interface information and keep it in global variables. If NULL, we'll find the first suitabl...
Definition: upnpapi.c:3570
int g_UpnpSdkEQMaxLen
Definition: upnpapi.c:182
Data structure representing the DOM Document.
Definition: ixml.h:159
ThreadPool gRecvThreadPool
Definition: upnpapi.c:124
Definition: VirtualDir.h:61
char Upnp_SID[44]
Holds the subscription identifier for a subscription between a client and a device.
Definition: upnp.h:448
char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN]
Definition: upnpapi.c:150
ThreadPool gMiniServerThreadPool
Definition: upnpapi.c:127
char DescXML[LINE_SIZE]
Definition: upnpapi.h:90
Definition: GenlibClientSubscription.c:18
Definition: upnpapi.h:71
Definition: LinkedList.h:83