45 #include "upnpconfig.h"
56 #ifdef UPNP_USE_MSVCPP
57 #include <sys/types.h>
59 #elif (defined(BSD) && BSD >= 199306)
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
94 #define UPNP_E_SUCCESS 0
99 #define UPNP_E_INVALID_HANDLE -100
107 #define UPNP_E_INVALID_PARAM -101
114 #define UPNP_E_OUTOF_HANDLE -102
116 #define UPNP_E_OUTOF_CONTEXT -103
123 #define UPNP_E_OUTOF_MEMORY -104
131 #define UPNP_E_INIT -105
133 #define UPNP_E_BUFFER_TOO_SMALL -106
140 #define UPNP_E_INVALID_DESC -107
149 #define UPNP_E_INVALID_URL -108
151 #define UPNP_E_INVALID_SID -109
153 #define UPNP_E_INVALID_DEVICE -110
161 #define UPNP_E_INVALID_SERVICE -111
169 #define UPNP_E_BAD_RESPONSE -113
171 #define UPNP_E_BAD_REQUEST -114
179 #define UPNP_E_INVALID_ACTION -115
186 #define UPNP_E_FINISH -116
193 #define UPNP_E_INIT_FAILED -117
200 #define UPNP_E_URL_TOO_BIG -118
211 #define UPNP_E_BAD_HTTPMSG -119
219 #define UPNP_E_ALREADY_REGISTERED -120
225 #define UPNP_E_INVALID_INTERFACE -121
234 #define UPNP_E_NETWORK_ERROR -200
244 #define UPNP_E_SOCKET_WRITE -201
254 #define UPNP_E_SOCKET_READ -202
264 #define UPNP_E_SOCKET_BIND -203
274 #define UPNP_E_SOCKET_CONNECT -204
284 #define UPNP_E_OUTOF_SOCKET -205
292 #define UPNP_E_LISTEN -206
300 #define UPNP_E_TIMEDOUT -207
308 #define UPNP_E_SOCKET_ERROR -208
310 #define UPNP_E_FILE_WRITE_ERROR -209
316 #define UPNP_E_CANCELED -210
318 #define UPNP_E_EVENT_PROTOCOL -300
323 #define UPNP_E_SUBSCRIBE_UNACCEPTED -301
328 #define UPNP_E_UNSUBSCRIBE_UNACCEPTED -302
333 #define UPNP_E_NOTIFY_UNACCEPTED -303
341 #define UPNP_E_INVALID_ARGUMENT -501
347 #define UPNP_E_FILE_NOT_FOUND -502
352 #define UPNP_E_FILE_READ_ERROR -503
358 #define UPNP_E_EXT_NOT_XML -504
360 #define UPNP_E_NO_WEB_SERVER -505
361 #define UPNP_E_OUTOF_BOUNDS -506
367 #define UPNP_E_NOT_FOUND -507
373 #define UPNP_E_INTERNAL_ERROR -911
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
384 #if UPNP_VERSION >= 10800
395 #include "ActionComplete.h"
396 #include "ActionRequest.h"
397 #include "Discovery.h"
399 #include "EventSubscribe.h"
400 #include "FileInfo.h"
401 #include "StateVarComplete.h"
402 #include "StateVarRequest.h"
403 #include "SubscriptionRequest.h"
412 enum UpnpOpenFileMode
603 #if UPNP_VERSION < 10800
856 Upnp_EventType EventType,
913 unsigned short DestPort);
947 #ifdef UPNP_ENABLE_IPV6
955 unsigned short DestPort);
1003 #ifdef UPNP_ENABLE_IPV6
1004 EXPORT_SPEC unsigned short UpnpGetServerPort6(
void);
1030 #ifdef UPNP_ENABLE_IPV6
1033 EXPORT_SPEC char *UpnpGetServerUlaGuaIp6Address(
void);
1074 const char *DescUrl,
1152 Upnp_DescType descriptionType,
1155 const char* description,
1208 const char *DescUrl,
1258 const char *DescUrl,
1270 const char *LowerDescUrl);
1319 int RegistrationState);
1378 size_t contentLength);
1399 size_t contentLength);
1450 const char *TTarget_constarget_const,
1452 const void *Cookie_const);
1503 int RegistrationState);
1550 const char *ActionURL,
1552 const char *VarName,
1579 const char *ActionURL,
1581 const char *VarName,
1586 const void *Cookie);
1615 const char *ActionURL,
1617 const char *ServiceType,
1653 const char *ActionURL,
1655 const char *ServiceType,
1692 const char *ActionURL,
1694 const char *ServiceType,
1704 const void *Cookie);
1731 const char *ActionURL,
1733 const char *ServiceType,
1746 const void *Cookie);
1797 const char **VarName,
1799 const char **NewVal,
1870 const char **VarName,
1872 const char **NewVal,
2005 const void *Cookie);
2025 int MaxSubscriptions);
2046 int MaxSubscriptionTimeOut);
2081 const char *PublisherUrl,
2141 const char *PublisherUrl,
2148 const void *Cookie);
2240 const void *Cookie);
2370 const char *proxy_str,
2536 const char *contentType,
2658 const char *rootDir);
2670 const char *filename,
2672 #if UPNP_VERSION < 10800
2694 const char *filename,
2697 enum UpnpOpenFileMode Mode);
2714 UpnpWebFileHandle fileHnd,
2735 UpnpWebFileHandle fileHnd,
2756 UpnpWebFileHandle fileHnd,
2782 UpnpWebFileHandle fileHnd);
2856 const char *dirName);
2867 const char *dirName);
int UpnpDownloadXmlDoc(const char *url, IXML_Document **xmlDoc)
Downloads an XML document specified in a URL.
Definition: upnpapi.c:3154
char * ServiceId
Definition: upnp.h:793
char Location[(size_t) 180]
Definition: upnp.h:748
int UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient.
Definition: upnp.h:425
IXML_Document * ActionResult
Definition: upnp.h:652
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:1081
char ActionName[(size_t) 256]
Definition: upnp.h:618
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:935
char StateVarName[(size_t) 256]
Definition: upnp.h:699
int UpnpRegisterRootDevice(const char *DescUrl, Upnp_FunPtr Callback, const void *Cookie, UpnpDevice_Handle *Hnd)
Returns the local IPv6 listening ip address.
Definition: upnpapi.c:770
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:2430
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:588
The { UpnpVirtualDirCallbacks} structure contains the pointers to file-related callback functions a d...
Definition: upnp.h:2799
IXML_Document * ActionRequest
Definition: upnp.h:627
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:3038
char DevUDN[(size_t) 256]
Definition: upnp.h:621
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:2798
int ErrCode
Definition: upnp.h:777
char ServiceID[(size_t) 256]
Definition: upnp.h:674
int UpnpVirtualDir_set_GetInfoCallback(VDCallback_GetInfo callback)
Sets the get_info callback function to be used to access a virtual directory.
Definition: upnpapi.c:4226
void UpnpRemoveAllVirtualDirs(void)
Removes all virtual directory mappings.
Definition: upnpapi.c:4136
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:2915
int UpnpRenewSubscription(UpnpClient_Handle Hnd, int *TimeOut, const Upnp_SID SubsId)
Renews a subscription that is about to expire.
Definition: upnpapi.c:2203
IXML_Document * ActionRequest
Definition: upnp.h:649
struct sockaddr_storage DestAddr
Definition: upnp.h:760
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:3060
int is_readable
Definition: upnp.h:820
Upnp_SType_e
Represents the different types of searches that can be performed using the SDK for UPnP Devices API...
Definition: upnp.h:565
int UpnpSetVirtualDirCallbacks(struct UpnpVirtualDirCallbacks *callbacks)
Sets the callback functions to be used to access a virtual directory.
Definition: upnpapi.c:4204
time_t last_modified
Definition: upnp.h:812
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:3082
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:1679
int Socket
Definition: upnp.h:665
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:2509
unsigned short UpnpGetServerPort(void)
Returns the internal server IPv4 UPnP listening port.
Definition: upnpapi.c:676
char DeviceId[(size_t) 180]
Definition: upnp.h:736
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:2137
int UpnpSetMaxSubscriptions(UpnpDevice_Handle Hnd, int MaxSubscriptions)
Sets the maximum number of subscriptions accepted per service.
Definition: upnpapi.c:1846
int UpnpRemoveVirtualDir(const char *dirName)
Removes a virtual directory mapping made with UpnpAddVirtualDir.
Definition: upnpapi.c:4088
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:2018
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:1266
int UpnpCloseHttpGet(void *handle)
Closes the connection and frees memory that was allocated for the handle parameter.
Definition: upnpapi.c:3119
char DevUDN[(size_t) 256]
Definition: upnp.h:671
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:1097
char * UDN
Definition: upnp.h:796
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:3125
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:2089
UpnpWebFileHandle(* VDCallback_Open)(const char *filename, enum UpnpOpenFileMode Mode)
Open callback function prototype.
Definition: upnp.h:2692
int UpnpVirtualDir_set_CloseCallback(VDCallback_Close callback)
Sets the close callback function to be used to access a virtual directory.
Definition: upnpapi.c:4291
char ServiceVer[(size_t) 180]
Definition: upnp.h:745
int UpnpSetContentLength(UpnpClient_Handle Hnd, size_t contentLength)
Definition: upnpapi.c:4303
int TimeOut
Definition: upnp.h:783
char StateVarName[(size_t) 256]
Definition: upnp.h:677
int UpnpVirtualDir_set_OpenCallback(VDCallback_Open callback)
Sets the open callback function to be used to access a virtual directory.
Definition: upnpapi.c:4239
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:3097
int ErrCode
Definition: upnp.h:662
int UpnpUnRegisterRootDevice(UpnpDevice_Handle Hnd)
Unregisters a root device registered with UpnpRegisterRootDevice, UpnpRegisterRootDevice2, UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4.
Definition: upnpapi.c:1259
DOMString content_type
Definition: upnp.h:825
int UpnpSendAdvertisement(UpnpDevice_Handle Hnd, int Exp)
Sends out the discovery announcements for all devices and services for a device.
Definition: upnpapi.c:1672
int ErrCode
Definition: upnp.h:730
int Expires
Definition: upnp.h:733
char ServiceID[(size_t) 256]
Definition: upnp.h:624
Upnp_EventType_e
The reason code for an event callback.
Definition: upnp.h:444
int UpnpVirtualDir_set_SeekCallback(VDCallback_Seek callback)
Sets the seek callback function to be used to access a virtual directory.
Definition: upnpapi.c:4278
int UpnpIsWebserverEnabled(void)
Returns TRUE if the webserver is enabled, or FALSE if it is not.
Definition: upnpapi.c:4195
int UpnpVirtualDir_set_ReadCallback(VDCallback_Read callback)
Sets the read callback function to be used to access a virtual directory.
Definition: upnpapi.c:4252
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:2594
Provides a platform independent way to include TCP/IP types and functions.
int(* VDCallback_GetInfo)(const char *filename, struct File_Info *info)
Get-info callback function prototype.
Definition: upnp.h:2668
int UpnpDownloadUrlItem(const char *url, char **outBuf, char *contentType)
Downloads a file specified in a URL.
Definition: upnpapi.c:3137
struct sockaddr_storage CtrlPtIPAddr
Definition: upnp.h:633
Upnp_SID Sid
Definition: upnp.h:799
UpnpString * CtrlUrl
Definition: upnp.h:646
Upnp_SID Sid
Definition: upnp.h:710
int UpnpInit(const char *HostIP, unsigned short DestPort)
Initializes the Linux SDK for UPnP Devices (IPv4 only).
Definition: upnpapi.c:430
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:3050
UpnpString * PublisherUrl
Definition: upnp.h:780
IXML_Document * SoapHeader
Definition: upnp.h:637
int ErrCode
Definition: upnp.h:609
int UpnpCancelHttpGet(void *handle)
Set the cancel flag of the handle parameter.
Definition: upnpapi.c:3113
int is_directory
Definition: upnp.h:816
Upnp_SID Sid
Definition: upnp.h:774
int UpnpDevice_Handle
Returned when a device application registers with UpnpRegisterRootDevice, UpnpRegisterRootDevice2, UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4.
Definition: upnp.h:435
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:2329
char ErrStr[(size_t) 180]
Definition: upnp.h:668
int(* VDCallback_Write)(UpnpWebFileHandle fileHnd, char *buf, size_t buflen)
Write callback function prototype.
Definition: upnp.h:2733
DOMString CurrentVal
Definition: upnp.h:684
DOMString CurrentVal
Definition: upnp.h:702
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:3069
IXML_Document * ActionResult
Definition: upnp.h:630
int UpnpSetMaxSubscriptionTimeOut(UpnpDevice_Handle Hnd, int MaxSubscriptionTimeOut)
Sets the maximum time-out accepted for a subscription request or renewal.
Definition: upnpapi.c:1883
int UpnpHttpGetProgress(void *handle, size_t *length, size_t *total)
Retrieve progress information of a http-get transfer.
Definition: upnpapi.c:3131
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:2650
int ErrCode
Definition: upnp.h:643
int(* VDCallback_Seek)(UpnpWebFileHandle fileHnd, off_t offset, int origin)
Seek callback function prototype.
Definition: upnp.h:2754
char Os[(size_t) 180]
Definition: upnp.h:751
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:2383
int(* VDCallback_Close)(UpnpWebFileHandle fileHnd)
Close callback function prototype.
Definition: upnp.h:2780
int ErrCode
Definition: upnp.h:693
int UpnpVirtualDir_set_WriteCallback(VDCallback_Write callback)
Sets the write callback function to be used to access a virtual directory.
Definition: upnpapi.c:4265
#define DOMString
The type of DOM strings.
Definition: ixml.h:59
char * UpnpGetServerIpAddress(void)
Returns the internal server IPv6 UPnP listening port.
Definition: upnpapi.c:694
void * UpnpWebFileHandle
The type of handle returned by the web server for open requests.
Definition: upnp.h:2663
off_t file_length
Definition: upnp.h:808
int UpnpUnRegisterClient(UpnpClient_Handle Hnd)
Unregisters a control point application, unsubscribing all active subscriptions.
Definition: upnpapi.c:1389
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:2706
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:1946
int(* VDCallback_Read)(UpnpWebFileHandle fileHnd, char *buf, size_t buflen)
Read callback function prototype.
Definition: upnp.h:2712
struct s_UpnpString UpnpString
Type of the string objects inside libupnp.
Definition: UpnpString.h:38
char Ext[(size_t) 180]
Definition: upnp.h:757
char Upnp_SID[44]
Holds the subscription identifier for a subscription between a client and a device.
Definition: upnp.h:555
int UpnpFinish(void)
Initializes the Linux SDK for UPnP Devices (IPv4 or IPv6).
Definition: upnpapi.c:595
int(* Upnp_FunPtr)(Upnp_EventType EventType, void *Event, void *Cookie)
Definition: upnp.h:854
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:2259
UpnpString * CtrlUrl
Definition: upnp.h:696
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:1789
int EventKey
Definition: upnp.h:713
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:4334
char Date[(size_t) 180]
Definition: upnp.h:754
int UpnpEnableWebserver(int enable)
Enables or disables the webserver.
Definition: upnpapi.c:4158
struct sockaddr_storage CtrlPtIPAddr
Definition: upnp.h:680
#define EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition: UpnpGlobal.h:81
int Socket
Definition: upnp.h:612
IXML_Document * ChangedVariables
Definition: upnp.h:716
char DeviceType[(size_t) 180]
Definition: upnp.h:739
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:1341
char ServiceType[(size_t) 180]
Definition: upnp.h:742
int UpnpAddVirtualDir(const char *dirName)
Adds a virtual directory mapping.
Definition: upnpapi.c:4025
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:2982
char ErrStr[(size_t) 180]
Definition: upnp.h:615