libUPnP  1.6.24
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 DEFAULT_INTERFACE 1
51 
52 #define DEV_LIMIT 200
53 
54 #define DEFAULT_MX 5
55 
56 #define DEFAULT_MAXAGE 1800
57 
58 #define DEFAULT_SOAP_CONTENT_LENGTH 16000
59 #define MAX_SOAP_CONTENT_LENGTH (size_t)32000
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 
118  ClientSubscription *ClientSubList;
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);
177 Upnp_Handle_Type GetDeviceHandleInfo(
179  int AddressFamily,
181  int *device_handle_out,
183  struct Handle_Info **HndInfo);
184 
185 
186 extern char gIF_NAME[LINE_SIZE];
187 extern char gIF_IPV4[INET_ADDRSTRLEN];
188 extern char gIF_IPV6[INET6_ADDRSTRLEN];
189 
190 extern char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN];
191 
192 extern unsigned gIF_INDEX;
193 
194 
195 extern unsigned short LOCAL_PORT_V4;
196 extern unsigned short LOCAL_PORT_V6;
197 
198 
201 
202 
207 
208 
209 typedef enum {
210  SUBSCRIBE,
211  UNSUBSCRIBE,
212  DK_NOTIFY,
213  QUERY,
214  ACTION,
215  STATUS,
216  DEVDESCRIPTION,
217  SERVDESCRIPTION,
218  MINI,
219  RENEW
220 } UpnpFunName;
221 
222 
224 {
225  UpnpFunName FunName;
226  int Handle;
227  int TimeOut;
228  char VarName[NAME_SIZE];
229  char NewVal[NAME_SIZE];
230  char DevType[NAME_SIZE];
231  char DevId[NAME_SIZE];
232  char ServiceType[NAME_SIZE];
233  char ServiceVer[NAME_SIZE];
234  UpnpString *Url;
235  Upnp_SID SubsId;
236  char *Cookie;
237  Upnp_FunPtr Fun;
238  IXML_Document *Header;
239  IXML_Document *Act;
240  struct DevDesc *Devdesc;
241 };
242 
243 
245 extern struct VirtualDirCallbacks virtualDirCallback;
246 
247 
248 typedef enum {
249  WEB_SERVER_DISABLED,
250  WEB_SERVER_ENABLED
251 } WebServerState;
252 
253 
254 #define E_HTTP_SYNTAX -6
255 
256 
276 int UpnpGetIfInfo(
278  const char *IfName);
279 
280 
281 void UpnpThreadDistribution(struct UpnpNonblockParam * Param);
282 
283 
288 void AutoAdvertise(
290  void *input);
291 
292 
301 int getlocalhostname(
303  char *out,
305  size_t out_len);
306 
307 
313 int PrintHandleInfo(
315  UpnpClient_Handle Hnd);
316 
317 
318 extern WebServerState bWebServerState;
319 
320 
321 #endif /* UPNPAPI_H */
322 
Upnp_FunPtr Callback
Definition: upnpapi.h:76
int UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient.
Definition: upnp.h:404
ClientSubscription * ClientSubList
Definition: upnpapi.h:118
IXML_Document * DescDocument
Definition: upnpapi.h:100
size_t g_maxContentLength
Definition: upnpapi.c:160
char DescURL[LINE_SIZE]
Definition: upnpapi.h:85
Definition: TimerThread.h:67
Definition: upnpapi.h:223
IXML_NodeList * DeviceList
Definition: upnpapi.h:102
Upnp_Handle_Type GetHandleInfo(int Hnd, struct Handle_Info **HndInfo)
Get handle information.
Definition: upnpapi.c:3821
int getlocalhostname(char *out, size_t out_len)
Get local IP address.
Definition: upnpapi.c:3874
char LowerDescURL[LINE_SIZE]
Definition: upnpapi.h:88
int g_UpnpSdkEQMaxAge
Definition: upnpapi.c:176
Upnp_Handle_Type HType
Definition: upnpapi.h:74
LinkedList SsdpSearchList
Definition: upnpapi.h:120
Definition: VirtualDir.h:11
ThreadPool gSendThreadPool
Definition: upnpapi.c:118
IXML_NodeList * ServiceList
Definition: upnpapi.h:104
WebServerState bWebServerState
Definition: upnpapi.c:127
Upnp_SID gUpnpSdkNLSuuid
int PrintHandleInfo(UpnpClient_Handle Hnd)
Print handle info.
Definition: upnpapi.c:3848
char gIF_IPV6[INET6_ADDRSTRLEN]
Definition: upnpapi.c:136
int MaxSubscriptionTimeOut
Definition: upnpapi.h:110
A thread pool similar to the thread pool in the UPnP SDK.
Definition: ThreadPool.h:212
Upnp_Handle_Type GetDeviceHandleInfo(int AddressFamily, int *device_handle_out, struct Handle_Info **HndInfo)
Retrieves the device handle and information of the first device of the address family spcified...
Definition: upnpapi.c:3789
unsigned short LOCAL_PORT_V6
Definition: upnpapi.c:148
TimerThread gTimerThread
Definition: upnpapi.c:115
int aliasInstalled
Definition: upnpapi.h:80
Definition: service_table.h:86
void AutoAdvertise(void *input)
This function is a timer thread scheduled by UpnpSendAdvertisement to the send advetisement again...
Definition: upnpapi.c:4034
unsigned short LOCAL_PORT_V4
Definition: upnpapi.c:145
void UpnpThreadDistribution(struct UpnpNonblockParam *Param)
Schedule async functions in threadpool.
Definition: upnpapi.c:3641
char gIF_NAME[LINE_SIZE]
Definition: upnpapi.c:130
char gIF_IPV4[INET_ADDRSTRLEN]
Definition: upnpapi.c:133
ithread_rwlock_t GlobalHndRWLock
Definition: upnpapi.c:105
int(* Upnp_FunPtr)(Upnp_EventType EventType, void *Event, void *Cookie)
Definition: upnp.h:917
Upnp_Handle_Type GetClientHandleInfo(int *client_handle_out, struct Handle_Info **HndInfo)
Get client handle info.
Definition: upnpapi.c:3762
service_table ServiceTable
Definition: upnpapi.h:106
Data structure representing a list of nodes.
Definition: ixml.h:235
virtualDirList * pVirtualDirList
Definition: upnpapi.c:97
unsigned gIF_INDEX
Definition: upnpapi.c:142
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:3250
int g_UpnpSdkEQMaxLen
Definition: upnpapi.c:166
Data structure representing the DOM Document.
Definition: ixml.h:187
ThreadPool gRecvThreadPool
Definition: upnpapi.c:121
struct s_UpnpString UpnpString
Type of the string objects inside libupnp.
Definition: UpnpString.h:38
Definition: VirtualDir.h:61
char Upnp_SID[44]
Holds the subscription identifier for a subscription between a client and a device.
Definition: upnp.h:534
char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN]
Definition: upnpapi.c:139
ThreadPool gMiniServerThreadPool
Definition: upnpapi.c:124
char DescXML[LINE_SIZE]
Definition: upnpapi.h:90
Definition: upnpapi.h:71
Definition: LinkedList.h:83