libUPnP  1.6.24
upnp.h
Go to the documentation of this file.
1 #ifndef UPNP_H
2 #define UPNP_H
3 
4 /*******************************************************************************
5  *
6  * Copyright (c) 2000-2003 Intel Corporation
7  * All rights reserved.
8  * Copyright (C) 2011-2012 France Telecom All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * * Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  * * Neither name of Intel Corporation nor the names of its contributors
19  * may be used to endorse or promote products derived from this software
20  * without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
26  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
30  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  ******************************************************************************/
35 
44 #include "ixml.h"
45 #include "upnpconfig.h"
46 #include "UpnpGlobal.h"
47 #include "UpnpInet.h"
48 #include "UpnpString.h"
49 
50 /*
51  * \todo Document the exact reason of these include files and solve this
52  * include mess in an include file like UpnpTime.h
53  */
54 #ifdef WIN32
55  #include <time.h>
56  #ifdef UPNP_USE_MSVCPP
57  #include <sys/types.h> /* needed for off_t */
58  #endif
59 #elif (defined(BSD) && BSD >= 199306)
60  #include <time.h>
61 #else
62  /* Other systems ??? */
63 #endif
64 
65 #define LINE_SIZE (size_t)180
66 #define NAME_SIZE (size_t)256
67 #define MNFT_NAME_SIZE 64
68 #define MODL_NAME_SIZE 32
69 #define SERL_NUMR_SIZE 64
70 #define MODL_DESC_SIZE 64
71 #define UPNP_INFINITE -1
72 #define UPNP_USING_CHUNKED -3
73 #define UPNP_UNTIL_CLOSE -4
74 
94 #define UPNP_E_SUCCESS 0
95 
99 #define UPNP_E_INVALID_HANDLE -100
100 
107 #define UPNP_E_INVALID_PARAM -101
108 
114 #define UPNP_E_OUTOF_HANDLE -102
115 
116 #define UPNP_E_OUTOF_CONTEXT -103
117 
123 #define UPNP_E_OUTOF_MEMORY -104
124 
131 #define UPNP_E_INIT -105
132 
133 #define UPNP_E_BUFFER_TOO_SMALL -106
134 
140 #define UPNP_E_INVALID_DESC -107
141 
149 #define UPNP_E_INVALID_URL -108
150 
151 #define UPNP_E_INVALID_SID -109
152 
153 #define UPNP_E_INVALID_DEVICE -110
154 
161 #define UPNP_E_INVALID_SERVICE -111
162 
169 #define UPNP_E_BAD_RESPONSE -113
170 
171 #define UPNP_E_BAD_REQUEST -114
172 
179 #define UPNP_E_INVALID_ACTION -115
180 
186 #define UPNP_E_FINISH -116
187 
193 #define UPNP_E_INIT_FAILED -117
194 
200 #define UPNP_E_URL_TOO_BIG -118
201 
211 #define UPNP_E_BAD_HTTPMSG -119
212 
219 #define UPNP_E_ALREADY_REGISTERED -120
220 
225 #define UPNP_E_INVALID_INTERFACE -121
226 
234 #define UPNP_E_NETWORK_ERROR -200
235 
244 #define UPNP_E_SOCKET_WRITE -201
245 
254 #define UPNP_E_SOCKET_READ -202
255 
264 #define UPNP_E_SOCKET_BIND -203
265 
274 #define UPNP_E_SOCKET_CONNECT -204
275 
284 #define UPNP_E_OUTOF_SOCKET -205
285 
292 #define UPNP_E_LISTEN -206
293 
300 #define UPNP_E_TIMEDOUT -207
301 
308 #define UPNP_E_SOCKET_ERROR -208
309 
310 #define UPNP_E_FILE_WRITE_ERROR -209
311 
316 #define UPNP_E_CANCELED -210
317 
318 #define UPNP_E_EVENT_PROTOCOL -300
319 
323 #define UPNP_E_SUBSCRIBE_UNACCEPTED -301
324 
328 #define UPNP_E_UNSUBSCRIBE_UNACCEPTED -302
329 
333 #define UPNP_E_NOTIFY_UNACCEPTED -303
334 
341 #define UPNP_E_INVALID_ARGUMENT -501
342 
347 #define UPNP_E_FILE_NOT_FOUND -502
348 
352 #define UPNP_E_FILE_READ_ERROR -503
353 
358 #define UPNP_E_EXT_NOT_XML -504
359 
360 #define UPNP_E_NO_WEB_SERVER -505
361 #define UPNP_E_OUTOF_BOUNDS -506
362 
367 #define UPNP_E_NOT_FOUND -507
368 
373 #define UPNP_E_INTERNAL_ERROR -911
374 
375 /* SOAP-related error codes */
376 #define UPNP_SOAP_E_INVALID_ACTION 401
377 #define UPNP_SOAP_E_INVALID_ARGS 402
378 #define UPNP_SOAP_E_OUT_OF_SYNC 403
379 #define UPNP_SOAP_E_INVALID_VAR 404
380 #define UPNP_SOAP_E_ACTION_FAILED 501
381 
382 /* @} ErrorCodes */
383 
384 
391 enum UpnpOpenFileMode
392 {
393  UPNP_READ,
394  UPNP_WRITE
395 };
396 
404 typedef int UpnpClient_Handle;
405 
414 typedef int UpnpDevice_Handle;
415 
424  /*
425  * Control callbacks
426  */
427 
433 
438 
444 
449 
450  /*
451  * Discovery callbacks
452  */
453 
459 
465 
471 
476 
477  /*
478  * Eventing callbacks
479  */
480 
491 
496 
501 
506 
511 
517 
523 };
524 
525 typedef enum Upnp_EventType_e Upnp_EventType;
526 
534 typedef char Upnp_SID[44];
535 
547 
550 
553 
557 };
558 
559 typedef enum Upnp_SType_e Upnp_SType;
560 
570 
574 
578 };
579 
580 typedef enum Upnp_DescType_e Upnp_DescType;
581 
585 {
587  int ErrCode;
588 
590  int Socket;
591 
593  char ErrStr[LINE_SIZE];
594 
596  char ActionName[NAME_SIZE];
597 
599  char DevUDN[NAME_SIZE];
600 
602  char ServiceID[NAME_SIZE];
603 
606 
609 
611  struct sockaddr_storage CtrlPtIPAddr;
612 
616 };
617 
618 /* compat code for libupnp-1.8 */
620 #define UpnpActionRequest_get_ErrCode(x) ((x)->ErrCode)
621 #define UpnpActionRequest_get_Socket(x) ((x)->Socket)
622 #define UpnpActionRequest_get_ErrStr_cstr(x) ((x)->ErrStr)
623 #define UpnpActionRequest_get_ActionName_cstr(x) ((x)->ActionName)
624 #define UpnpActionRequest_get_DevUDN_cstr(x) ((x)->DevUDN)
625 #define UpnpActionRequest_get_ServiceID_cstr(x) ((x)->ServiceID)
626 #define UpnpActionRequest_get_ActionRequest(x) ((x)->ActionRequest)
627 #define UpnpActionRequest_get_ActionResult(x) ((x)->ActionResult)
628 
630 {
632  int ErrCode;
633 
636 
639 
642 
643 };
644 
645 /* compat code for libupnp-1.8 */
647 #define UpnpActionComplete_get_ErrCode(x) ((x)->ErrCode)
648 #define UpnpActionComplete_get_CtrlUrl_cstr(x) (UpnpString_get_String((x)->CtrlUrl))
649 #define UpnpActionComplete_get_ActionRequest(x) ((x)->ActionRequest)
650 #define UpnpActionComplete_get_ActionResult(x) ((x)->ActionResult)
651 
656 {
658  int ErrCode;
659 
661  int Socket;
662 
664  char ErrStr[LINE_SIZE];
665 
667  char DevUDN[NAME_SIZE];
668 
670  char ServiceID[NAME_SIZE];
671 
673  char StateVarName[NAME_SIZE];
674 
676  struct sockaddr_storage CtrlPtIPAddr;
677 
681 };
682 
683 /* compat code for libupnp-1.8 */
685 #define UpnpStateVarRequest_get_ErrCode(x) ((x)->ErrCode)
686 #define UpnpStateVarRequest_get_Socket(x) ((x)->Socket)
687 #define UpnpStateVarRequest_get_ErrStr_cstr(x) ((x)->ErrStr)
688 #define UpnpStateVarRequest_get_DevUDN_cstr(x) ((x)->DevUDN)
689 #define UpnpStateVarRequest_get_ServiceID_cstr(x) ((x)->ServiceID)
690 #define UpnpStateVarRequest_get_StateVarName_cstr(x) ((x)->StateVarName)
691 
696 {
698  int ErrCode;
699 
702 
704  char StateVarName[NAME_SIZE];
705 
708 };
709 
710 /* compat code for libupnp-1.8 */
712 #define UpnpStateVarComplete_get_ErrCode(x) ((x)->ErrCode)
713 #define UpnpStateVarComplete_get_CtrlUrl_cstr(x) (UpnpString_get_String((x)->CtrlUrl))
714 #define UpnpStateVarComplete_get_StateVarName_cstr(x) ((x)->StateVarName)
715 
719 {
722 
724  int EventKey;
725 
728 
729 };
730 
731 /* compat code for libupnp-1.8 */
732 typedef struct Upnp_Event UpnpEvent;
733 #define UpnpEvent_get_SID_cstr(x) ((x)->Sid)
734 #define UpnpEvent_get_EventKey(x) ((x)->EventKey)
735 #define UpnpEvent_get_ChangedVariables(x) ((x)->ChangedVariables)
736 
737 /*
738  * This typedef is required by Doc++ to parse the last entry of the
739  * Upnp_Discovery structure correctly.
740  */
741 
742 
745 {
747  int ErrCode;
748 
750  int Expires;
751 
753  char DeviceId[LINE_SIZE];
754 
756  char DeviceType[LINE_SIZE];
757 
759  char ServiceType[LINE_SIZE];
760 
762  char ServiceVer[LINE_SIZE];
763 
765  char Location[LINE_SIZE];
766 
768  char Os[LINE_SIZE];
769 
771  char Date[LINE_SIZE];
772 
774  char Ext[LINE_SIZE];
775 
777  struct sockaddr_storage DestAddr;
778 };
779 
780 /* compat code for libupnp-1.8 */
781 typedef struct Upnp_Discovery UpnpDiscovery;
782 #define UpnpDiscovery_get_ErrCode(x) ((x)->ErrCode)
783 #define UpnpDiscovery_get_Expires(x) ((x)->Expires)
784 #define UpnpDiscovery_get_DeviceID_cstr(x) ((x)->DeviceId)
785 #define UpnpDiscovery_get_DeviceType_cstr(x) ((x)->DeviceType)
786 #define UpnpDiscovery_get_ServiceType_cstr(x) ((x)->ServiceType)
787 #define UpnpDiscovery_get_ServiceVer_cstr(x) ((x)->ServiceVer)
788 #define UpnpDiscovery_get_Location_cstr(x) ((x)->Location)
789 #define UpnpDiscovery_get_Os_cstr(x) ((x)->Os)
790 #define UpnpDiscovery_get_Date_cstr(x) ((x)->Date)
791 #define UpnpDiscovery_get_Ext_cstr(x) ((x)->Ext)
792 
797 
805 
807  int ErrCode;
808 
811 
813  int TimeOut;
814 
815 };
816 
817 /* compat code for libupnp-1.8 */
819 #define UpnpEventSubscribe_get_SID_cstr(x) ((x)->Sid)
820 #define UpnpEventSubscribe_get_ErrCode(x) ((x)->ErrCode)
821 #define UpnpEventSubscribe_get_PublisherUrl_cstr(x) (UpnpString_get_String((x)->PublisherUrl))
822 #define UpnpEventSubscribe_get_TimeOut(x) ((x)->TimeOut)
823 
828 {
830  char *ServiceId;
831 
833  char *UDN;
834 
837 };
838 
839 /* compat code for libupnp-1.8 */
841 #define UpnpSubscriptionRequest_get_ServiceId_cstr(x) ((x)->ServiceId)
842 #define UpnpSubscriptionRequest_get_UDN_cstr(x) ((x)->UDN)
843 #define UpnpSubscriptionRequest_get_SID_cstr(x) ((x)->Sid)
844 
846 {
850  char *name;
851  char *value;
852  DOMString resp;
853 };
854 
855 struct File_Info
856 {
860  off_t file_length;
861 
865 
869 
873 
878 
883 };
884 
885 /* compat code for libupnp-1.8 */
886 typedef struct File_Info UpnpFileInfo;
887 #define UpnpFileInfo_get_FileLength(x) ((x)->file_length)
888 #define UpnpFileInfo_get_LastModified(x) ((x)->last_modified)
889 #define UpnpFileInfo_get_IsDirectory(x) ((x)->is_directory)
890 #define UpnpFileInfo_get_IsReadable(x) ((x)->is_readable)
891 
917 typedef int (*Upnp_FunPtr)(
919  Upnp_EventType EventType,
921  void *Event,
923  void *Cookie);
924 
925 /* @} Constants and Types */
926 
927 #ifdef __cplusplus
928 extern "C" {
929 #endif /* __cplusplus */
930 
973  const char *HostIP,
976  unsigned short DestPort);
977 
1010 #ifdef UPNP_ENABLE_IPV6
1011 EXPORT_SPEC int UpnpInit2(
1015  const char *IfName,
1018  unsigned short DestPort);
1019 #endif
1020 
1040 EXPORT_SPEC int UpnpFinish(void);
1041 
1053 EXPORT_SPEC unsigned short UpnpGetServerPort(void);
1054 
1066 #ifdef UPNP_ENABLE_IPV6
1067 EXPORT_SPEC unsigned short UpnpGetServerPort6(void);
1068 #endif
1069 
1081 
1093 #ifdef UPNP_ENABLE_IPV6
1095 
1096 EXPORT_SPEC char *UpnpGetServerUlaGuaIp6Address(void);
1097 #endif
1098 
1137  const char *DescUrl,
1139  Upnp_FunPtr Callback,
1141  const void *Cookie,
1143  UpnpDevice_Handle *Hnd);
1144 
1215  Upnp_DescType descriptionType,
1218  const char* description,
1221  size_t bufferLen,
1224  int config_baseURL,
1226  Upnp_FunPtr Fun,
1229  const void* Cookie,
1231  UpnpDevice_Handle* Hnd);
1232 
1271  const char *DescUrl,
1273  Upnp_FunPtr Callback,
1275  const void *Cookie,
1277  UpnpDevice_Handle *Hnd,
1280  int AddressFamily);
1281 
1321  const char *DescUrl,
1323  Upnp_FunPtr Callback,
1325  const void *Cookie,
1327  UpnpDevice_Handle *Hnd,
1330  int AddressFamily,
1333  const char *LowerDescUrl);
1334 
1353  UpnpDevice_Handle Hnd);
1354 
1376  UpnpDevice_Handle Hnd,
1378  int PowerState,
1380  int SleepPeriod,
1382  int RegistrationState);
1383 
1404  Upnp_FunPtr Callback,
1406  const void *Cookie,
1408  UpnpClient_Handle *Hnd);
1409 
1428  UpnpClient_Handle Hnd);
1429 
1439  UpnpClient_Handle Hnd,
1441  size_t contentLength);
1442 
1462  size_t contentLength);
1463 
1464 /* @} Initialization and Registration */
1465 
1466 /******************************************************************************
1467  ******************************************************************************
1468  * *
1469  * D I S C O V E R Y *
1470  * *
1471  ******************************************************************************
1472  ******************************************************************************/
1473 
1505  UpnpClient_Handle Hnd,
1510  int Mx,
1513  const char *TTarget_constarget_const,
1515  const void *Cookie_const);
1516 
1534  UpnpDevice_Handle Hnd,
1540  int Exp);
1541 
1562  UpnpDevice_Handle Hnd,
1568  int Exp,
1570  int PowerState,
1572  int SleepPeriod,
1574  int RegistrationState);
1575 
1576 /* @} Discovery */
1577 
1578 /******************************************************************************
1579  ******************************************************************************
1580  * *
1581  * C O N T R O L *
1582  * *
1583  ******************************************************************************
1584  ******************************************************************************/
1585 
1619  UpnpClient_Handle Hnd,
1621  const char *ActionURL,
1623  const char *VarName,
1627  DOMString *StVarVal);
1628 
1648  UpnpClient_Handle Hnd,
1650  const char *ActionURL,
1652  const char *VarName,
1655  Upnp_FunPtr Fun,
1657  const void *Cookie);
1658 
1684  UpnpClient_Handle Hnd,
1686  const char *ActionURL,
1688  const char *ServiceType,
1690  const char *DevUDN,
1692  IXML_Document *Action,
1695  IXML_Document **RespNode);
1696 
1722  UpnpClient_Handle Hnd,
1724  const char *ActionURL,
1726  const char *ServiceType,
1728  const char *DevUDN,
1731  IXML_Document *Header,
1733  IXML_Document *Action,
1736  IXML_Document **RespNode);
1737 
1761  UpnpClient_Handle Hnd,
1763  const char *ActionURL,
1765  const char *ServiceType,
1767  const char *DevUDN,
1769  IXML_Document *Action,
1772  Upnp_FunPtr Fun,
1775  const void *Cookie);
1776 
1800  UpnpClient_Handle Hnd,
1802  const char *ActionURL,
1804  const char *ServiceType,
1806  const char *DevUDN,
1809  IXML_Document *Header,
1811  IXML_Document *Action,
1814  Upnp_FunPtr Fun,
1817  const void *Cookie);
1818 
1821 /******************************************************************************
1822  ******************************************************************************
1823  * *
1824  * E V E N T I N G *
1825  * *
1826  ******************************************************************************
1827  ******************************************************************************/
1828 
1862  UpnpDevice_Handle Hnd,
1864  const char *DevID,
1866  const char *ServID,
1868  const char **VarName,
1870  const char **NewVal,
1872  int cVariables,
1874  const Upnp_SID SubsId);
1875 
1900  UpnpDevice_Handle Hnd,
1902  const char *DevID,
1904  const char *ServID,
1908  IXML_Document *PropSet,
1910  Upnp_SID SubsId);
1911 
1937  const char *DevID,
1939  const char *ServID,
1941  const char **VarName,
1943  const char **NewVal,
1945  int cVariables);
1946 
1972  const char *DevID,
1974  const char *ServID,
1978  IXML_Document *PropSet);
1979 
2010  UpnpClient_Handle Hnd,
2013  int *TimeOut,
2015  const Upnp_SID SubsId);
2016 
2066  UpnpClient_Handle Hnd,
2069  int TimeOut,
2071  Upnp_SID SubsId,
2074  Upnp_FunPtr Fun,
2076  const void *Cookie);
2077 
2094  UpnpDevice_Handle Hnd,
2096  int MaxSubscriptions);
2097 
2115  UpnpDevice_Handle Hnd,
2117  int MaxSubscriptionTimeOut);
2118 
2150  UpnpClient_Handle Hnd,
2152  const char *PublisherUrl,
2156  int *TimeOut,
2158  Upnp_SID SubsId);
2159 
2210  UpnpClient_Handle Hnd,
2212  const char *PublisherUrl,
2215  int TimeOut,
2217  Upnp_FunPtr Fun,
2219  const void *Cookie);
2220 
2252  UpnpClient_Handle Hnd,
2254  const Upnp_SID SubsId);
2255 
2304  UpnpClient_Handle Hnd,
2306  Upnp_SID SubsId,
2309  Upnp_FunPtr Fun,
2311  const void *Cookie);
2312 
2316 /******************************************************************************
2317  ******************************************************************************
2318  * *
2319  * C L I E N T - A P I *
2320  * *
2321  ******************************************************************************
2322  ******************************************************************************/
2323 
2358  const char *url,
2360  char **outBuf,
2363  char *contentType);
2364 
2395  const char *url,
2397  void **handle,
2399  char **contentType,
2401  int *contentLength,
2403  int *httpStatus,
2407  int timeout);
2408 
2439  const char *url,
2441  const char *proxy_str,
2443  void **handle,
2445  char **contentType,
2447  int *contentLength,
2449  int *httpStatus,
2453  int timeout);
2454 
2487  const char *url,
2489  void **handle,
2491  char **contentType,
2493  int *contentLength,
2495  int *httpStatus,
2497  int lowRange,
2499  int highRange,
2503  int timeout);
2504 
2524  void *handle,
2526  char *buf,
2528  size_t *size,
2532  int timeout);
2533 
2544  void *handle,
2546  size_t *length,
2548  size_t *total);
2549 
2560  void *handle);
2561 
2573  void *handle);
2574 
2602  const char *url,
2605  void **handle,
2607  const char *contentType,
2609  int contentLength,
2612  int timeout);
2613 
2630  void *handle,
2632  char *buf,
2634  size_t *size,
2637  int timeout);
2638 
2655  void *handle,
2657  int *httpStatus,
2660  int timeout);
2661 
2691  const char *url,
2693  IXML_Document **xmlDoc);
2694 
2697 /******************************************************************************
2698  ******************************************************************************
2699  * *
2700  * W E B S E R V E R A P I *
2701  * *
2702  ******************************************************************************
2703  ******************************************************************************/
2704 
2729  const char *rootDir);
2730 
2734 typedef void *UpnpWebFileHandle;
2735 
2739 typedef int (*VDCallback_GetInfo)(
2741  const char *filename,
2743  struct File_Info *info);
2744 
2754 
2760  const char *filename,
2763  enum UpnpOpenFileMode Mode);
2764 
2774 
2778 typedef int (*VDCallback_Read)(
2780  UpnpWebFileHandle fileHnd,
2782  char *buf,
2784  size_t buflen);
2785 
2795 
2799 typedef int (*VDCallback_Write)(
2801  UpnpWebFileHandle fileHnd,
2803  char *buf,
2805  size_t buflen);
2806 
2816 
2820 typedef int (*VDCallback_Seek) (
2822  UpnpWebFileHandle fileHnd,
2826  off_t offset,
2831  int origin);
2832 
2842 
2846 typedef int (*VDCallback_Close)(
2848  UpnpWebFileHandle fileHnd);
2849 
2859 
2866 {
2867  VDCallback_GetInfo get_info;
2868  VDCallback_Open open;
2869  VDCallback_Read read;
2870  VDCallback_Write write;
2871  VDCallback_Seek seek;
2872  VDCallback_Close close;
2873 };
2874 
2884  int enable);
2885 
2894 
2904  struct UpnpVirtualDirCallbacks *callbacks );
2905 
2922  const char *dirName);
2923 
2933  const char *dirName);
2934 
2939 
2940 /* @} Web Server API */
2941 
2942 #ifdef __cplusplus
2943 }
2944 #endif /* __cplusplus */
2945 
2946 /* @} UPnPAPI UPnP API */
2947 
2948 #endif /* UPNP_H */
int UpnpDownloadXmlDoc(const char *url, IXML_Document **xmlDoc)
Downloads an XML document specified in a URL.
Definition: upnpapi.c:3189
char * ServiceId
Definition: upnp.h:830
Definition: upnp.h:510
int UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient.
Definition: upnp.h:404
IXML_Document * ActionResult
Definition: upnp.h:641
int UpnpRegisterRootDevice3(const char *DescUrl, Upnp_FunPtr Callback, const void *Cookie, UpnpDevice_Handle *Hnd, int AddressFamily)
Registers a device application for a specific address family with the UPnP library.
Definition: upnpapi.c:1099
char ActionName[(size_t) 256]
Definition: upnp.h:596
int UpnpRegisterRootDevice2(Upnp_DescType descriptionType, const char *description, size_t bufferLen, int config_baseURL, Upnp_FunPtr Fun, const void *Cookie, UpnpDevice_Handle *Hnd)
Registers a device application with the UPnP Library. Similar to UpnpRegisterRootDevice, except that it also allows the description document to be specified as a file or a memory buffer.
Definition: upnpapi.c:953
int UpnpRegisterRootDevice(const char *DescUrl, Upnp_FunPtr Callback, const void *Cookie, UpnpDevice_Handle *Hnd)
Registers a device application with the UPnP Library.
Definition: upnpapi.c:788
int UpnpAcceptSubscription(UpnpDevice_Handle Hnd, const char *DevID, const char *ServID, const char **VarName, const char **NewVal, int cVariables, const Upnp_SID SubsId)
Accepts a subscription request and sends out the current state of the eventable variables for a servi...
Definition: upnpapi.c:2455
int UpnpSetWebServerRootDir(const char *rootDir)
Sets the document root directory for the internal web server.
Upnp_DescType_e
Specifies the type of description in UpnpRegisterRootDevice2.
Definition: upnp.h:567
Definition: upnp.h:522
Definition: upnp.h:744
The { UpnpVirtualDirCallbacks} structure contains the pointers to file-related callback functions a d...
Definition: upnp.h:2865
IXML_Document * ActionRequest
Definition: upnp.h:605
int UpnpOpenHttpPost(const char *url, void **handle, const char *contentType, int contentLength, int timeout)
Makes an HTTP POST request message, opens a connection to the server and sends the POST request to th...
Definition: upnpapi.c:3073
char DevUDN[(size_t) 256]
Definition: upnp.h:599
int UpnpSendActionExAsync(UpnpClient_Handle Hnd, const char *ActionURL, const char *ServiceType, const char *DevUDN, IXML_Document *Header, IXML_Document *Action, Upnp_FunPtr Fun, const void *Cookie)
Sends a message to change a state variable in a service, generating a callback when the operation is ...
Definition: upnpapi.c:2826
int ErrCode
Definition: upnp.h:807
int UpnpVirtualDir_set_GetInfoCallback(VDCallback_GetInfo callback)
Sets the get_info callback function to be used to access a virtual directory.
Definition: upnpapi.c:4263
Definition: upnp.h:516
Definition: upnp.h:470
void UpnpRemoveAllVirtualDirs(void)
Removes all virtual directory mappings.
Definition: upnpapi.c:4173
int UpnpGetServiceVarStatusAsync(UpnpClient_Handle Hnd, const char *ActionURL, const char *VarName, Upnp_FunPtr Fun, const void *Cookie)
Queries the state of a variable of a service, generating a callback when the operation is complete...
Definition: upnpapi.c:2948
int UpnpRenewSubscription(UpnpClient_Handle Hnd, int *TimeOut, const Upnp_SID SubsId)
Renews a subscription that is about to expire.
Definition: upnpapi.c:2226
IXML_Document * ActionRequest
Definition: upnp.h:638
int UpnpCloseHttpPost(void *handle, int *httpStatus, int timeout)
Sends and receives any pending data, closes the connection with the server, and frees memory allocate...
Definition: upnpapi.c:3095
int is_readable
Definition: upnp.h:872
Upnp_SType_e
Represents the different types of searches that can be performed using the SDK for UPnP Devices API...
Definition: upnp.h:544
int UpnpSetVirtualDirCallbacks(struct UpnpVirtualDirCallbacks *callbacks)
Sets the callback functions to be used to access a virtual directory.
Definition: upnpapi.c:4241
time_t last_modified
Definition: upnp.h:864
UpnpString object declaration.
int UpnpOpenHttpGetProxy(const char *url, const char *proxy_str, void **handle, char **contentType, int *contentLength, int *httpStatus, int timeout)
Gets a file specified in a URL through the specified proxy.
Definition: upnpapi.c:3117
int UpnpSendAdvertisementLowPower(UpnpDevice_Handle Hnd, int Exp, int PowerState, int SleepPeriod, int RegistrationState)
Sends out the discovery announcements for all devices and services for a device.
Definition: upnpapi.c:1696
int Socket
Definition: upnp.h:661
int UpnpAcceptSubscriptionExt(UpnpDevice_Handle Hnd, const char *DevID, const char *ServID, IXML_Document *PropSet, Upnp_SID SubsId)
Similar to UpnpAcceptSubscription() except that it takes a DOM document for the variables to event ra...
Definition: upnpapi.c:2534
Definition: upnp.h:475
unsigned short UpnpGetServerPort(void)
Returns the internal server IPv4 UPnP listening port.
Definition: upnpapi.c:694
int UpnpUnSubscribeAsync(UpnpClient_Handle Hnd, Upnp_SID SubsId, Upnp_FunPtr Fun, const void *Cookie)
Removes a subscription of a control point from a service previously subscribed to using UpnpSubscribe...
Definition: upnpapi.c:2158
int UpnpSetMaxSubscriptions(UpnpDevice_Handle Hnd, int MaxSubscriptions)
Sets the maximum number of subscriptions accepted per service.
Definition: upnpapi.c:1865
struct Extra_Headers * extra_headers
Definition: upnp.h:882
int UpnpRemoveVirtualDir(const char *dirName)
Removes a virtual directory mapping made with UpnpAddVirtualDir.
Definition: upnpapi.c:4124
Definition: upnp.h:495
Definition: upnp.h:437
int UpnpSubscribe(UpnpClient_Handle Hnd, const char *PublisherUrl, int *TimeOut, Upnp_SID SubsId)
Registers a control point to receive event notifications from another device.
Definition: upnpapi.c:2039
int UpnpUnRegisterRootDeviceLowPower(UpnpDevice_Handle Hnd, int PowerState, int SleepPeriod, int RegistrationState)
Unregisters a root device registered with UpnpRegisterRootDevice, UpnpRegisterRootDevice2, UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4.
Definition: upnpapi.c:1284
int UpnpCloseHttpGet(void *handle)
Closes the connection and frees memory that was allocated for the handle parameter.
Definition: upnpapi.c:3154
Definition: upnp.h:577
int UpnpRegisterRootDevice4(const char *DescUrl, Upnp_FunPtr Callback, const void *Cookie, UpnpDevice_Handle *Hnd, int AddressFamily, const char *LowerDescUrl)
Registers a device application for a specific address family with the UPnP library. This function can also be used to specify a dedicated description URL to be returned for legacy CPs.
Definition: upnpapi.c:1115
char * UDN
Definition: upnp.h:833
Definition: upnp.h:546
int UpnpReadHttpGet(void *handle, char *buf, size_t *size, int timeout)
Gets specified number of bytes from a file specified in a URL.
Definition: upnpapi.c:3160
int UpnpUnSubscribe(UpnpClient_Handle Hnd, const Upnp_SID SubsId)
Removes the subscription of a control point from a service previously subscribed to using UpnpSubscri...
Definition: upnpapi.c:2110
Definition: upnp.h:549
int UpnpVirtualDir_set_CloseCallback(VDCallback_Close callback)
Sets the close callback function to be used to access a virtual directory.
Definition: upnpapi.c:4328
Definition: upnp.h:490
int UpnpSetContentLength(UpnpClient_Handle Hnd, size_t contentLength)
Definition: upnpapi.c:4340
int TimeOut
Definition: upnp.h:813
int UpnpVirtualDir_set_OpenCallback(VDCallback_Open callback)
Sets the open callback function to be used to access a virtual directory.
Definition: upnpapi.c:4276
Definition: upnp.h:573
int UpnpOpenHttpGetEx(const char *url, void **handle, char **contentType, int *contentLength, int *httpStatus, int lowRange, int highRange, int timeout)
Gets specified number of bytes from a file specified in the URL.
Definition: upnpapi.c:3132
Definition: upnp.h:845
int UpnpInit2(const char *IfName, unsigned short DestPort)
Initializes the Linux SDK for UPnP Devices (IPv4 or IPv6).
Definition: upnp.h:796
int ErrCode
Definition: upnp.h:658
int UpnpUnRegisterRootDevice(UpnpDevice_Handle Hnd)
Unregisters a root device registered with UpnpRegisterRootDevice, UpnpRegisterRootDevice2, UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4.
Definition: upnpapi.c:1277
DOMString content_type
Definition: upnp.h:877
int UpnpSendAdvertisement(UpnpDevice_Handle Hnd, int Exp)
Sends out the discovery announcements for all devices and services for a device.
Definition: upnpapi.c:1689
int ErrCode
Definition: upnp.h:747
int Expires
Definition: upnp.h:750
Definition: upnp.h:556
Definition: upnp.h:695
int(* VDCallback_GetInfo)(const char *filename, struct File_Info *info)
Get-info callback function prototype.
Definition: upnp.h:2739
Definition: upnp.h:584
char ServiceID[(size_t) 256]
Definition: upnp.h:602
Upnp_EventType_e
The reason code for an event callback.
Definition: upnp.h:423
Definition: upnp.h:505
Definition: upnp.h:569
int UpnpVirtualDir_set_SeekCallback(VDCallback_Seek callback)
Sets the seek callback function to be used to access a virtual directory.
Definition: upnpapi.c:4315
int UpnpIsWebserverEnabled(void)
Returns TRUE if the webserver is enabled, or FALSE if it is not.
Definition: upnpapi.c:4232
Definition: upnp.h:827
int UpnpVirtualDir_set_ReadCallback(VDCallback_Read callback)
Sets the read callback function to be used to access a virtual directory.
Definition: upnpapi.c:4289
int UpnpSendAction(UpnpClient_Handle Hnd, const char *ActionURL, const char *ServiceType, const char *DevUDN, IXML_Document *Action, IXML_Document **RespNode)
Sends a message to change a state variable in a service.
Definition: upnpapi.c:2619
Provides a platform independent way to include TCP/IP types and functions.
int UpnpDownloadUrlItem(const char *url, char **outBuf, char *contentType)
Downloads a file specified in a URL.
Definition: upnpapi.c:3172
struct sockaddr_storage CtrlPtIPAddr
Definition: upnp.h:611
Definition: upnp.h:443
Upnp_SID Sid
Definition: upnp.h:836
Definition: upnp.h:655
UpnpString * CtrlUrl
Definition: upnp.h:635
Upnp_SID Sid
Definition: upnp.h:721
int UpnpInit(const char *HostIP, unsigned short DestPort)
Initializes the Linux SDK for UPnP Devices (IPv4 only).
Definition: upnpapi.c:448
int UpnpWriteHttpPost(void *handle, char *buf, size_t *size, int timeout)
Sends a request to a server to copy the contents of a buffer to the URI specified in the UpnpOpenHttp...
Definition: upnpapi.c:3085
UpnpString * PublisherUrl
Definition: upnp.h:810
IXML_Document * SoapHeader
Definition: upnp.h:615
int ErrCode
Definition: upnp.h:587
int UpnpCancelHttpGet(void *handle)
Set the cancel flag of the handle parameter.
Definition: upnpapi.c:3148
int is_directory
Definition: upnp.h:868
Upnp_SID Sid
Definition: upnp.h:804
Definition: upnp.h:855
int UpnpDevice_Handle
Returned when a device application registers with UpnpRegisterRootDevice, UpnpRegisterRootDevice2, UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4.
Definition: upnp.h:414
int UpnpNotify(UpnpDevice_Handle, const char *DevID, const char *ServID, const char **VarName, const char **NewVal, int cVariables)
Sends out an event change notification to all control points subscribed to a particular service...
Definition: upnpapi.c:2354
int(* Upnp_FunPtr)(Upnp_EventType EventType, void *Event, void *Cookie)
Definition: upnp.h:917
DOMString CurrentVal
Definition: upnp.h:680
DOMString CurrentVal
Definition: upnp.h:707
Definition: upnp.h:718
Definition: upnp.h:448
int UpnpOpenHttpGet(const char *url, void **handle, char **contentType, int *contentLength, int *httpStatus, int timeout)
Gets a file specified in a URL.
Definition: upnpapi.c:3104
IXML_Document * ActionResult
Definition: upnp.h:608
int UpnpSetMaxSubscriptionTimeOut(UpnpDevice_Handle Hnd, int MaxSubscriptionTimeOut)
Sets the maximum time-out accepted for a subscription request or renewal.
Definition: upnpapi.c:1902
unsigned short UpnpGetServerPort6(void)
Returns the internal server IPv6 UPnP listening port.
int UpnpHttpGetProgress(void *handle, size_t *length, size_t *total)
Retrieve progress information of a http-get transfer.
Definition: upnpapi.c:3166
int UpnpSendActionEx(UpnpClient_Handle Hnd, const char *ActionURL, const char *ServiceType, const char *DevUDN, IXML_Document *Header, IXML_Document *Action, IXML_Document **RespNode)
Sends a message to change a state variable in a service.
Definition: upnpapi.c:2675
int ErrCode
Definition: upnp.h:632
int UpnpNotifyExt(UpnpDevice_Handle, const char *DevID, const char *ServID, IXML_Document *PropSet)
Similar to UpnpNotify except that it takes a DOM document for the event rather than an array of strin...
Definition: upnpapi.c:2408
UpnpWebFileHandle(* VDCallback_Open)(const char *filename, enum UpnpOpenFileMode Mode)
Open callback function prototype.
Definition: upnp.h:2758
int ErrCode
Definition: upnp.h:698
int UpnpVirtualDir_set_WriteCallback(VDCallback_Write callback)
Sets the write callback function to be used to access a virtual directory.
Definition: upnpapi.c:4302
int(* VDCallback_Close)(UpnpWebFileHandle fileHnd)
Close callback function prototype.
Definition: upnp.h:2846
#define DOMString
The type of DOM strings.
Definition: ixml.h:59
int(* VDCallback_Write)(UpnpWebFileHandle fileHnd, char *buf, size_t buflen)
Write callback function prototype.
Definition: upnp.h:2799
char * UpnpGetServerIpAddress(void)
Returns the local IPv4 listening ip address.
Definition: upnpapi.c:712
char * UpnpGetServerIp6Address(void)
Returns the local IPv6 listening ip address.
Definition: upnpapi.c:720
Definition: upnp.h:552
Definition: upnp.h:432
void * UpnpWebFileHandle
The type of handle returned by the web server for open requests.
Definition: upnp.h:2734
off_t file_length
Definition: upnp.h:860
int(* VDCallback_Read)(UpnpWebFileHandle fileHnd, char *buf, size_t buflen)
Read callback function prototype.
Definition: upnp.h:2778
int UpnpUnRegisterClient(UpnpClient_Handle Hnd)
Unregisters a control point application, unsubscribing all active subscriptions.
Definition: upnpapi.c:1407
Data structure representing the DOM Document.
Definition: ixml.h:187
int UpnpSendActionAsync(UpnpClient_Handle Hnd, const char *ActionURL, const char *ServiceType, const char *DevUDN, IXML_Document *Action, Upnp_FunPtr Fun, const void *Cookie)
Sends a message to change a state variable in a service, generating a callback when the operation is ...
Definition: upnpapi.c:2731
int UpnpSubscribeAsync(UpnpClient_Handle Hnd, const char *PublisherUrl, int TimeOut, Upnp_FunPtr Fun, const void *Cookie)
Performs the same operation as UpnpSubscribe, but returns immediately and calls the registered callba...
Definition: upnpapi.c:1965
struct s_UpnpString UpnpString
Type of the string objects inside libupnp.
Definition: UpnpString.h:38
char Upnp_SID[44]
Holds the subscription identifier for a subscription between a client and a device.
Definition: upnp.h:534
int UpnpFinish(void)
Terminates the Linux SDK for UPnP Devices.
Definition: upnpapi.c:613
int UpnpRenewSubscriptionAsync(UpnpClient_Handle Hnd, int TimeOut, Upnp_SID SubsId, Upnp_FunPtr Fun, const void *Cookie)
Renews a subscription that is about to expire, generating a callback when the operation is complete...
Definition: upnpapi.c:2282
int(* VDCallback_Seek)(UpnpWebFileHandle fileHnd, off_t offset, int origin)
Seek callback function prototype.
Definition: upnp.h:2820
UpnpString * CtrlUrl
Definition: upnp.h:701
int UpnpSearchAsync(UpnpClient_Handle Hnd, int Mx, const char *TTarget_constarget_const, const void *Cookie_const)
Searches for devices matching the given search target.
Definition: upnpapi.c:1808
int EventKey
Definition: upnp.h:724
int UpnpSetMaxContentLength(size_t contentLength)
Sets the maximum content-length that the SDK will process on an incoming SOAP requests or responses...
Definition: upnpapi.c:4371
Definition: upnp.h:500
int UpnpEnableWebserver(int enable)
Enables or disables the webserver.
Definition: upnpapi.c:4195
#define EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition: UpnpGlobal.h:81
int Socket
Definition: upnp.h:590
char * name
Definition: upnp.h:850
IXML_Document * ChangedVariables
Definition: upnp.h:727
Definition: upnp.h:629
Defines constants that for some reason are not defined on some systems.
int UpnpRegisterClient(Upnp_FunPtr Callback, const void *Cookie, UpnpClient_Handle *Hnd)
Registers a control point application with the UPnP Library.
Definition: upnpapi.c:1359
int UpnpAddVirtualDir(const char *dirName)
Adds a virtual directory mapping.
Definition: upnpapi.c:4061
int UpnpGetServiceVarStatus(UpnpClient_Handle Hnd, const char *ActionURL, const char *VarName, DOMString *StVarVal)
Queries the state of a state variable of a service on another device.
Definition: upnpapi.c:3017
char ErrStr[(size_t) 180]
Definition: upnp.h:593