47 #include "upnpconfig.h"
58 #elif (defined(BSD) && BSD >= 199306)
68 #include <sys/param.h>
76 #define INVALID_SOCKET (SOCKET)(~0)
81 #define UpnpCloseSocket closesocket
84 #define UpnpCloseSocket close
88 #define NUM_HANDLE 200
91 #define MNFT_NAME_SIZE 64
92 #define MODL_NAME_SIZE 32
93 #define SERL_NUMR_SIZE 64
94 #define MODL_DESC_SIZE 64
95 #define UPNP_INFINITE -1
96 #define UPNP_USING_CHUNKED -3
97 #define UPNP_UNTIL_CLOSE -4
119 #define UPNP_E_SUCCESS 0
124 #define UPNP_E_INVALID_HANDLE -100
132 #define UPNP_E_INVALID_PARAM -101
139 #define UPNP_E_OUTOF_HANDLE -102
141 #define UPNP_E_OUTOF_CONTEXT -103
148 #define UPNP_E_OUTOF_MEMORY -104
156 #define UPNP_E_INIT -105
158 #define UPNP_E_BUFFER_TOO_SMALL -106
164 #define UPNP_E_INVALID_DESC -107
173 #define UPNP_E_INVALID_URL -108
175 #define UPNP_E_INVALID_SID -109
177 #define UPNP_E_INVALID_DEVICE -110
185 #define UPNP_E_INVALID_SERVICE -111
193 #define UPNP_E_BAD_RESPONSE -113
195 #define UPNP_E_BAD_REQUEST -114
203 #define UPNP_E_INVALID_ACTION -115
210 #define UPNP_E_FINISH -116
217 #define UPNP_E_INIT_FAILED -117
224 #define UPNP_E_URL_TOO_BIG -118
235 #define UPNP_E_BAD_HTTPMSG -119
243 #define UPNP_E_ALREADY_REGISTERED -120
249 #define UPNP_E_INVALID_INTERFACE -121
258 #define UPNP_E_NETWORK_ERROR -200
268 #define UPNP_E_SOCKET_WRITE -201
278 #define UPNP_E_SOCKET_READ -202
288 #define UPNP_E_SOCKET_BIND -203
298 #define UPNP_E_SOCKET_CONNECT -204
308 #define UPNP_E_OUTOF_SOCKET -205
316 #define UPNP_E_LISTEN -206
324 #define UPNP_E_TIMEDOUT -207
332 #define UPNP_E_SOCKET_ERROR -208
334 #define UPNP_E_FILE_WRITE_ERROR -209
340 #define UPNP_E_CANCELED -210
342 #define UPNP_E_EVENT_PROTOCOL -300
347 #define UPNP_E_SUBSCRIBE_UNACCEPTED -301
352 #define UPNP_E_UNSUBSCRIBE_UNACCEPTED -302
357 #define UPNP_E_NOTIFY_UNACCEPTED -303
365 #define UPNP_E_INVALID_ARGUMENT -501
371 #define UPNP_E_FILE_NOT_FOUND -502
376 #define UPNP_E_FILE_READ_ERROR -503
382 #define UPNP_E_EXT_NOT_XML -504
384 #define UPNP_E_NO_WEB_SERVER -505
385 #define UPNP_E_OUTOF_BOUNDS -506
391 #define UPNP_E_NOT_FOUND -507
397 #define UPNP_E_INTERNAL_ERROR -911
400 #define UPNP_SOAP_E_INVALID_ACTION 401
401 #define UPNP_SOAP_E_INVALID_ARGS 402
402 #define UPNP_SOAP_E_OUT_OF_SYNC 403
403 #define UPNP_SOAP_E_INVALID_VAR 404
404 #define UPNP_SOAP_E_ACTION_FAILED 501
448 enum UpnpOpenFileMode
666 Upnp_EventType EventType,
726 unsigned short DestPort);
768 unsigned short DestPort);
965 Upnp_DescType descriptionType,
968 const char* description,
1022 const char *DescUrl,
1031 const int AddressFamily);
1133 size_t contentLength);
1188 const char *TTarget_constarget_const,
1190 const void *Cookie_const);
1262 const char *ActionURL,
1264 const char *VarName,
1292 const char *ActionURL,
1294 const char *VarName,
1299 const void *Cookie);
1329 const char *ActionURL,
1331 const char *ServiceType,
1368 const char *ActionURL,
1370 const char *ServiceType,
1408 const char *ActionURL,
1410 const char *ServiceType,
1420 const void *Cookie);
1448 const char *ActionURL,
1450 const char *ServiceType,
1463 const void *Cookie);
1518 const char **VarName,
1520 const char **NewVal,
1593 const char **VarName,
1595 const char **NewVal,
1731 const void *Cookie);
1752 int MaxSubscriptions);
1774 int MaxSubscriptionTimeOut);
1810 const char *PublisherUrl,
1871 const char *PublisherUrl,
1878 const void *Cookie);
1972 const void *Cookie);
2106 const char *proxy_str,
2214 unsigned int *length,
2216 unsigned int *total);
2277 const char *contentType,
2403 const char *rootDir);
2417 const char *filename,
2438 const char *filename,
2441 enum UpnpOpenFileMode Mode);
2460 UpnpWebFileHandle fileHnd,
2483 UpnpWebFileHandle fileHnd,
2506 UpnpWebFileHandle fileHnd,
2534 UpnpWebFileHandle fileHnd);
2586 const char *dirName);
2598 const char *dirName);
int UpnpDownloadXmlDoc(const char *url, IXML_Document **xmlDoc)
Downloads an XML document specified in a URL.
Definition: upnpapi.c:2807
int UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient.
Definition: upnp.h:461
UpnpEventSubscribe object declararion.
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:790
UpnpActionRequest object declaration.
const char * UpnpGetServerIp6Address(void)
Returns the local IPv6 listening ip address.
Definition: upnpapi.c:628
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:639
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:2117
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:623
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:2688
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:2466
int UpnpVirtualDir_set_GetInfoCallback(VDCallback_GetInfo callback)
Sets the get_info callback function to be used to access a virtual directory.
Definition: upnpapi.c:3812
void UpnpRemoveAllVirtualDirs(void)
Removes all virtual directory mappings.
Definition: upnpapi.c:3743
int(* VDCallback_GetInfo)(const char *filename, UpnpFileInfo *info)
Get-info callback function prototype.
Definition: upnp.h:2415
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:2574
int UpnpRenewSubscription(UpnpClient_Handle Hnd, int *TimeOut, const Upnp_SID SubsId)
Renews a subscription that is about to expire.
Definition: upnpapi.c:1906
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:2710
Upnp_SType_e
Represents the different types of searches that can be performed using the SDK for UPnP Devices API...
Definition: upnp.h:600
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:2732
unsigned short UpnpGetServerPort(void)
Returns the internal server IPv4 UPnP listening port.
Definition: upnpapi.c:598
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:1846
int UpnpSetMaxSubscriptions(UpnpDevice_Handle Hnd, int MaxSubscriptions)
Sets the maximum number of subscriptions accepted per service.
Definition: upnpapi.c:1604
int UpnpRemoveVirtualDir(const char *dirName)
Removes a virtual directory mapping made with UpnpAddVirtualDir.
Definition: upnpapi.c:3692
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:1734
int UpnpCloseHttpGet(void *handle)
Closes the connection and frees memory that was allocated for the handle parameter.
Definition: upnpapi.c:2769
int UpnpRegisterRootDevice3(const char *DescUrl, Upnp_FunPtr Callback, const void *Cookie, UpnpDevice_Handle *Hnd, const int AddressFamily)
Registers a device application for a specific address family with the UPnP library.
Definition: upnpapi.c:920
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:1801
UpnpWebFileHandle(* VDCallback_Open)(const char *filename, enum UpnpOpenFileMode Mode)
Open callback function prototype.
Definition: upnp.h:2436
int UpnpVirtualDir_set_CloseCallback(VDCallback_Close callback)
Sets the close callback function to be used to access a virtual directory.
Definition: upnpapi.c:3877
Definition: ssdplib.h:117
int UpnpVirtualDir_set_OpenCallback(VDCallback_Open callback)
Sets the open callback function to be used to access a virtual directory.
Definition: upnpapi.c:3825
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:2747
int UpnpInit2(const char *IfName, unsigned short DestPort)
Initializes the Linux SDK for UPnP Devices (IPv4 or IPv6).
Definition: upnpapi.c:476
int UpnpUnRegisterRootDevice(UpnpDevice_Handle Hnd)
Unregisters a root device registered with UpnpRegisterRootDevice or UpnpRegisterRootDevice2.
Definition: upnpapi.c:1054
int UpnpSendAdvertisement(UpnpDevice_Handle Hnd, int Exp)
Sends out the discovery announcements for all devices and services for a device.
Definition: upnpapi.c:1457
int UpnpHttpGetProgress(void *handle, unsigned int *length, unsigned int *total)
Retrieve progress information of a http-get transfer.
Definition: upnpapi.c:2781
Upnp_EventType_e
The reason code for an event callback.
Definition: upnp.h:479
UpnpStateVarRequest object declararion.
int UpnpVirtualDir_set_SeekCallback(VDCallback_Seek callback)
Sets the seek callback function to be used to access a virtual directory.
Definition: upnpapi.c:3864
int UpnpIsWebserverEnabled(void)
Returns TRUE if the webserver is enabled, or FALSE if it is not.
Definition: upnpapi.c:3802
int UpnpVirtualDir_set_ReadCallback(VDCallback_Read callback)
Sets the read callback function to be used to access a virtual directory.
Definition: upnpapi.c:3838
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:2275
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:2787
int UpnpInit(const char *HostIP, unsigned short DestPort)
Initializes the Linux SDK for UPnP Devices (IPv4 only).
Definition: upnpapi.c:420
int UpnpCancelHttpGet(void *handle)
Set the cancel flag of the handle parameter.
Definition: upnpapi.c:2763
UpnpActionComplete object declararion.
int UpnpDevice_Handle
Returned when a device application registers with UpnpRegisterRootDevice or UpnpRegisterRootDevice2.
Definition: upnp.h:470
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:2022
struct s_UpnpFileInfo UpnpFileInfo
Definition: FileInfo.h:17
int(* VDCallback_Write)(UpnpWebFileHandle fileHnd, char *buf, size_t buflen)
Write callback function prototype.
Definition: upnp.h:2481
UpnpFileInfo object declararion.
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:2719
int UpnpSetMaxSubscriptionTimeOut(UpnpDevice_Handle Hnd, int MaxSubscriptionTimeOut)
Sets the maximum time-out accepted for a subscription request or renewal.
Definition: upnpapi.c:1635
unsigned short UpnpGetServerPort6(void)
Returns the internal server IPv6 UPnP listening port.
Definition: upnpapi.c:608
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:2328
int UpnpReadHttpGet(void *handle, char *buf, unsigned int *size, int timeout)
Gets specified number of bytes from a file specified in a URL.
Definition: upnpapi.c:2775
int(* VDCallback_Seek)(UpnpWebFileHandle fileHnd, off_t offset, int origin)
Seek callback function prototype.
Definition: upnp.h:2504
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:2073
UpnpEvent object declararion.
int(* VDCallback_Close)(UpnpWebFileHandle fileHnd)
Close callback function prototype.
Definition: upnp.h:2532
UpnpDiscovery object declararion.
int UpnpVirtualDir_set_WriteCallback(VDCallback_Write callback)
Sets the write callback function to be used to access a virtual directory.
Definition: upnpapi.c:3851
#define DOMString
The type of DOM strings.
Definition: ixml.h:55
void * UpnpWebFileHandle
The type of handle returned by the web server for open requests.
Definition: upnp.h:2409
int UpnpUnRegisterClient(UpnpClient_Handle Hnd)
Unregisters a control point application, unsubscribing all active subscriptions.
Definition: upnpapi.c:1175
Data structure representing the DOM Document.
Definition: ixml.h:183
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:2381
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:1668
int(* VDCallback_Read)(UpnpWebFileHandle fileHnd, char *buf, size_t buflen)
Read callback function prototype.
Definition: upnp.h:2458
char Upnp_SID[44]
Holds the subscription identifier for a subscription between a client and a device.
Definition: upnp.h:590
const char * UpnpGetServerIpAddress(void)
Returns the local IPv4 listening ip address.
Definition: upnpapi.c:618
int UpnpFinish(void)
Terminates the Linux SDK for UPnP Devices.
Definition: upnpapi.c:524
int(* Upnp_FunPtr)(Upnp_EventType EventType, void *Event, void *Cookie)
Definition: upnp.h:664
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:1958
UpnpSubscriptionRequest object declararion.
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:1553
int UpnpWriteHttpPost(void *handle, char *buf, unsigned int *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:2700
int UpnpAcceptSubscriptionExt(UpnpDevice_Handle Hnd, const char *DevID, const char *ServID, IXML_Document *PropSet, const Upnp_SID SubsId)
Similar to UpnpAcceptSubscription() except that it takes a DOM document for the variables to event ra...
Definition: upnpapi.c:2193
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:3925
UpnpStateVarComplete object declararion.
int UpnpEnableWebserver(int enable)
Enables or disables the webserver.
Definition: upnpapi.c:3765
int UpnpSetContentLength(UpnpClient_Handle Hnd, int contentLength)
Definition: upnpapi.c:3890
#define EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition: UpnpGlobal.h:82
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:1118
int UpnpAddVirtualDir(const char *dirName)
Adds a virtual directory mapping.
Definition: upnpapi.c:3636
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:2635