upnp.h

Go to the documentation of this file.

#ifndef UPNP_H
#define UPNP_H
 
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation 
 * Copyright (C) 2011-2012 France Telecom All rights reserved.
 * Copyright (C) 2020 J.F. Dockes <jf@dockes.org>
 * All rights reserved. 
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met: 
 *
 * * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer. 
 * * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution. 
 * * Neither name of Intel Corporation nor the names of its contributors 
 * may be used to endorse or promote products derived from this software 
 * without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
 
#include <cstdint>
#include <ctime>
#include <map>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
 
#include "upnpconfig.h"
#ifdef _WIN32
#include <winsock2.h>
#else
#include <sys/socket.h>
#endif
#include "UpnpGlobal.h"
 
#define LINE_SIZE  size_t(180)
#define NAME_SIZE  size_t(256)
#define UPNP_INFINITE        -1
#define UPNP_USING_CHUNKED -3
#define UPNP_UNTIL_CLOSE -4
 
#define UPNP_MAX_SEARCH_TIME 80
 
#define UPNP_MIN_SEARCH_TIME 2
 
 
#define UPNP_E_SUCCESS            0
 
#define UPNP_E_INVALID_HANDLE        -100
 
#define UPNP_E_INVALID_PARAM        -101
 
#define UPNP_E_OUTOF_HANDLE        -102
 
#define UPNP_E_OUTOF_CONTEXT        -103
 
#define UPNP_E_OUTOF_MEMORY        -104
 
#define UPNP_E_INIT            -105
 
#define UPNP_E_BUFFER_TOO_SMALL        -106
 
#define UPNP_E_INVALID_DESC        -107
 
#define UPNP_E_INVALID_URL        -108
 
#define UPNP_E_INVALID_SID        -109
 
#define UPNP_E_INVALID_DEVICE        -110
 
#define UPNP_E_INVALID_SERVICE        -111
 
#define UPNP_E_BAD_RESPONSE        -113
 
#define UPNP_E_BAD_REQUEST        -114
 
#define UPNP_E_INVALID_ACTION        -115
 
#define UPNP_E_FINISH            -116
 
#define UPNP_E_INIT_FAILED        -117
 
#define UPNP_E_URL_TOO_BIG        -118
 
#define UPNP_E_BAD_HTTPMSG        -119
 
#define UPNP_E_ALREADY_REGISTERED    -120
 
#define UPNP_E_INVALID_INTERFACE    -121
 
#define UPNP_E_NETWORK_ERROR        -200
 
#define UPNP_E_SOCKET_WRITE        -201
 
#define UPNP_E_SOCKET_READ        -202
 
#define UPNP_E_SOCKET_BIND        -203
 
#define UPNP_E_SOCKET_CONNECT        -204
 
#define UPNP_E_OUTOF_SOCKET        -205
 
#define UPNP_E_LISTEN            -206
 
#define UPNP_E_TIMEDOUT            -207
 
#define UPNP_E_SOCKET_ERROR        -208
 
#define UPNP_E_FILE_WRITE_ERROR        -209
 
#define UPNP_E_CANCELED            -210
 
#define UPNP_E_EVENT_PROTOCOL        -300
 
#define UPNP_E_SUBSCRIBE_UNACCEPTED    -301
 
#define UPNP_E_UNSUBSCRIBE_UNACCEPTED    -302
 
#define UPNP_E_NOTIFY_UNACCEPTED    -303
 
#define UPNP_E_INVALID_ARGUMENT        -501
 
#define UPNP_E_FILE_NOT_FOUND        -502
 
#define UPNP_E_FILE_READ_ERROR        -503
 
#define UPNP_E_EXT_NOT_XML        -504
 
#define UPNP_E_NO_WEB_SERVER        -505
 
#define UPNP_E_OUTOF_BOUNDS        -506
 
#define UPNP_E_NOT_FOUND        -507
 
#define UPNP_E_INTERNAL_ERROR        -911
 
/* SOAP-related error codes */
#define UPNP_SOAP_E_INVALID_ACTION   401
#define UPNP_SOAP_E_INVALID_ARGS     402
#define UPNP_SOAP_E_OUT_OF_SYNC      403
#define UPNP_SOAP_E_INVALID_VAR      404
#define UPNP_SOAP_E_ACTION_FAILED    501
 
/* @} ErrorCodes */
 
 
enum UpnpOpenFileMode
{
    UPNP_READ,
    UPNP_WRITE
};
 
typedef int  UpnpClient_Handle;
 
typedef int  UpnpDevice_Handle;
 
typedef enum Upnp_EventType_e {
    /*  Control callbacks */
 
    UPNP_CONTROL_ACTION_REQUEST,
 
    UPNP_CONTROL_ACTION_COMPLETE,
    UPNP_CONTROL_GET_VAR_REQUEST,
 
    UPNP_CONTROL_GET_VAR_COMPLETE,
 
    
    /* Discovery callbacks */
 
    UPNP_DISCOVERY_ADVERTISEMENT_ALIVE,
 
    UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE,
 
    UPNP_DISCOVERY_SEARCH_RESULT,
 
    UPNP_DISCOVERY_SEARCH_TIMEOUT,
 
    /* Eventing callbacks */
 
    UPNP_EVENT_SUBSCRIPTION_REQUEST,
 
    UPNP_EVENT_RECEIVED,
 
    UPNP_EVENT_RENEWAL_COMPLETE,
 
    UPNP_EVENT_SUBSCRIBE_COMPLETE,
 
    UPNP_EVENT_UNSUBSCRIBE_COMPLETE,
 
    UPNP_EVENT_AUTORENEWAL_FAILED,
 
    UPNP_EVENT_SUBSCRIPTION_EXPIRED
} Upnp_EventType;
 
 
 
typedef std::string Upnp_SID;
 
typedef enum Upnp_DescType_e { 
    UPNPREG_URL_DESC, 
    
    UPNPREG_FILENAME_DESC,
    
    UPNPREG_BUF_DESC 
} Upnp_DescType;
 
typedef enum {
    UPNP_FLAG_NONE = 0,
    UPNP_FLAG_IPV6 = 0x1,
    UPNP_FLAG_IPV6_REQUIRED = 0x2,
    UPNP_FLAG_NO_HOST_VALIDATE = 0x4,
    UPNP_FLAG_REJECT_HOSTNAMES = 0x8,
} Upnp_InitFlag;
 
typedef enum {
    UPNP_OPTION_END = 0,
    UPNP_OPTION_NETWORK_WAIT,
    UPNP_OPTION_BOOTID,
    UPNP_OPTION_CONFIGID,
    UPNP_OPTION_NEXTBOOTID,
    UPNP_OPTION_SEARCHPORT,
} Upnp_InitOption;
 
struct Upnp_Action_Request {
    int ErrCode;
 
    /* Old comment said socket number ?? Not set, kept for ABI */
    int unused1;
 
    char ErrStr[LINE_SIZE];
 
    char ActionName[NAME_SIZE];
 
    char DevUDN[NAME_SIZE];
 
    char ServiceID[NAME_SIZE];
 
    std::vector<std::pair<std::string, std::string> > args;
 
    std::vector<std::pair<std::string, std::string> > resdata;
 
    struct sockaddr_storage CtrlPtIPAddr;
 
    std::string Os;
 
    std::string xmlAction;
 
    std::string xmlResponse;
};
 
/* compat code for libupnp-1.8 */
typedef struct Upnp_Action_Request UpnpActionRequest;
#define UpnpActionRequest_get_ErrCode(x) ((x)->ErrCode)
#define UpnpActionRequest_set_ErrCode(x, v) ((x)->ErrCode = (v))
#define UpnpActionRequest_get_Socket(x) ((x)->Socket)
#define UpnpActionRequest_get_ErrStr_cstr(x) ((x)->ErrStr)
#define UpnpActionRequest_set_ErrStr(x, v) (strncpy((x)->ErrStr, v, LINE_SIZE))
#define UpnpActionRequest_strcpy_ErrStr(x, v) (strncpy((x)->ErrStr, v, LINE_SIZE))
#define UpnpActionRequest_get_ActionName_cstr(x) ((x)->ActionName)
#define UpnpActionRequest_get_DevUDN_cstr(x) ((x)->DevUDN)
#define UpnpActionRequest_get_ServiceID_cstr(x) ((x)->ServiceID)
#define UpnpActionRequest_get_xmlAction(x) ((x)->xmlAction)
#define UpnpActionRequest_get_xmlResponse(x) ((x)->xmlResponse)
#define UpnpActionRequest_set_xmlResponse(x, v) ((x)->xmlResponse = (v))
#define UpnpActionRequest_get_CtrlPtIPAddr(x) (&((x)->CtrlPtIPAddr))
#define UpnpActionRequest_get_Os_cstr(x) ((x)->Os.c_str())
 
struct Upnp_Event {
    Upnp_SID Sid;
 
    int EventKey;
 
    std::unordered_map<std::string, std::string> ChangedVariables;
};
 
/* compat code for libupnp-1.8 */
typedef struct Upnp_Event UpnpEvent;
#define UpnpEvent_get_SID_cstr(x) ((x)->Sid.c_str())
#define UpnpEvent_get_EventKey(x) ((x)->EventKey)
#define UpnpEvent_get_ChangedVariables(x) ((x)->ChangedVariables)
 
struct Upnp_Discovery {
    int  ErrCode;                  
                     
    int  Expires;                  
                     
    char DeviceId[LINE_SIZE];      
 
    char DeviceType[LINE_SIZE];    
 
    char ServiceType[LINE_SIZE];
 
    char ServiceVer[LINE_SIZE];    
 
    char Location[LINE_SIZE];      
 
    char Os[LINE_SIZE];            
                     
    char Date[LINE_SIZE];            
                     
    char Ext[LINE_SIZE];           
                     
    struct sockaddr_storage DestAddr;
};
 
/* compat code for libupnp-1.8 */
typedef struct Upnp_Discovery UpnpDiscovery;
#define UpnpDiscovery_get_ErrCode(x) ((x)->ErrCode)
#define UpnpDiscovery_get_Expires(x) ((x)->Expires)
#define UpnpDiscovery_get_DeviceID_cstr(x) ((x)->DeviceId)
#define UpnpDiscovery_get_DeviceType_cstr(x) ((x)->DeviceType)
#define UpnpDiscovery_get_ServiceType_cstr(x) ((x)->ServiceType)
#define UpnpDiscovery_get_ServiceVer_cstr(x) ((x)->ServiceVer)
#define UpnpDiscovery_get_Location_cstr(x) ((x)->Location)
#define UpnpDiscovery_get_Os_cstr(x) ((x)->Os)
#define UpnpDiscovery_get_Date_cstr(x) ((x)->Date)
#define UpnpDiscovery_get_Ext_cstr(x) ((x)->Ext)
#define UpnpDiscovery_get_Os_cstr(x) ((x)->Os)
#define UpnpDiscovery_get_DestAddr(x) (&((x)->DestAddr))
    
struct Upnp_Event_Subscribe {
 
    Upnp_SID Sid;            
 
    int ErrCode;              
 
    char PublisherUrl[NAME_SIZE]; 
 
    int TimeOut;              
};
 
/* compat code for libupnp-1.8 */
typedef struct Upnp_Event_Subscribe UpnpEventSubscribe;
#define UpnpEventSubscribe_get_SID_cstr(x) ((x)->Sid.c_str())
#define UpnpEventSubscribe_get_ErrCode(x) ((x)->ErrCode)
#define UpnpEventSubscribe_get_PublisherUrl_cstr(x) ((x)->PublisherUrl)
#define UpnpEventSubscribe_get_TimeOut(x) ((x)->TimeOut)
  
struct Upnp_Subscription_Request {
    const char *ServiceId; 
 
    const char *UDN;       
 
    Upnp_SID Sid;
};
 
/* compat code for libupnp-1.8 */
typedef struct Upnp_Subscription_Request UpnpSubscriptionRequest;
#define UpnpSubscriptionRequest_get_ServiceId_cstr(x) ((x)->ServiceId)
#define UpnpSubscriptionRequest_get_UDN_cstr(x) ((x)->UDN)
#define UpnpSubscriptionRequest_get_SID_cstr(x) ((x)->Sid.c_str())
 
struct File_Info {
    int64_t file_length{0};
 
    time_t last_modified{0};
 
    int is_directory{0};
 
    int is_readable{0};
 
    std::string content_type;
 
    struct sockaddr_storage CtrlPtIPAddr;
 
    std::string Os;
    
    std::map<std::string, std::string> request_headers;
 
    std::vector<std::pair<std::string, std::string>> response_headers;
};
 
/* Compat code for libupnp-1.8 */
typedef struct File_Info UpnpFileInfo;
#define UpnpFileInfo_get_FileLength(x) ((x)->file_length)
#define UpnpFileInfo_set_FileLength(x, v) ((x)->file_length = (v))
#define UpnpFileInfo_get_LastModified(x) ((x)->last_modified)
#define UpnpFileInfo_set_LastModified(x, v) ((x)->last_modified = (v))
#define UpnpFileInfo_get_IsDirectory(x) ((x)->is_directory)
#define UpnpFileInfo_set_IsDirectory(x, v) ((x)->is_directory = (v))
#define UpnpFileInfo_get_IsReadable(x) ((x)->is_readable)
#define UpnpFileInfo_set_IsReadable(x, v) ((x)->is_readable = (v))
#define UpnpFileInfo_get_ContentType(x) ((x)->content_type)
#define UpnpFileInfo_set_ContentType(x, v) ((x)->content_type = (v))
#define UpnpFileInfo_get_CtrlPtIPAddr(x) (&((x)->CtrlPtIPAddr))
#define UpnpFileInfo_get_Os_cstr(x) ((x)->Os.c_str())
    
typedef int (*Upnp_FunPtr)(
    Upnp_EventType EventType, const void *Event, void *Cookie);
 
 
EXPORT_SPEC int UpnpInit(
    const char *HostIP,
    unsigned short DestPort);
 
EXPORT_SPEC int UpnpInit2( 
    const char *IfName, unsigned short DestPort);
 
EXPORT_SPEC int UpnpInit2( 
    const std::vector<std::string>& ifnames, unsigned short DestPort);
 
EXPORT_SPEC int UpnpInitWithOptions( 
    const char *IfNames,
    unsigned short DestPort,
    unsigned int flags,
    ...
    );
 
 
EXPORT_SPEC int UpnpFinish(void);
 
EXPORT_SPEC unsigned short UpnpGetServerPort(void);
 
#ifdef UPNP_ENABLE_IPV6
EXPORT_SPEC unsigned short UpnpGetServerPort6(void);
 
EXPORT_SPEC unsigned short UpnpGetServerUlaGuaPort6(void);
#endif
 
EXPORT_SPEC const char *UpnpGetServerIpAddress(void);
 
#ifdef UPNP_ENABLE_IPV6
EXPORT_SPEC const char *UpnpGetServerIp6Address(void);
 
EXPORT_SPEC const char *UpnpGetServerUlaGuaIp6Address(void);
#endif
 
EXPORT_SPEC int UpnpSetMaxContentLength(
    size_t contentLength);
 
EXPORT_SPEC int UpnpRegisterRootDevice(
    const char *DescUrl,
    Upnp_FunPtr Fun,
    const void *Cookie,
    UpnpDevice_Handle *Hnd);
 
EXPORT_SPEC int UpnpRegisterRootDevice2(
    Upnp_DescType descriptionType,
    const char* description,
    size_t bufferLen,
    int ignored,
    Upnp_FunPtr Fun,
    const void* Cookie,
    UpnpDevice_Handle* Hnd);
 
EXPORT_SPEC int UpnpRegisterRootDevice4(
    const char *DescUrl,
    Upnp_FunPtr Fun,
    const void *Cookie,
    UpnpDevice_Handle *Hnd,
    int,
    const char *LowerDescUrl);
 
EXPORT_SPEC int UpnpDeviceSetProduct(
    UpnpDevice_Handle Hnd,
    const char *product,
    const char *version);
 
EXPORT_SPEC int UpnpUnRegisterRootDevice(
    UpnpDevice_Handle Hnd);
 
EXPORT_SPEC int UpnpUnRegisterRootDeviceLowPower(
    UpnpDevice_Handle Hnd,
    int PowerState,
    int SleepPeriod,
    int RegistrationState);
 
EXPORT_SPEC int UpnpRegisterClient(
    Upnp_FunPtr Fun,
    const void *Cookie,
    UpnpClient_Handle *Hnd);
 
EXPORT_SPEC void UpnpClientSetProduct(
    UpnpClient_Handle Hnd,
    const char *product,
    const char *version);
 
EXPORT_SPEC int UpnpUnRegisterClient(
    UpnpClient_Handle Hnd);
 
/******************************************************************************
 *                                                                            *
 *                        D I S C O V E R Y                                   *
 *                                                                            *
 ******************************************************************************/
EXPORT_SPEC int UpnpSearchAsync(
    UpnpClient_Handle Hnd,
    int Mx,
    const char *Target,
    const void *cookie); 
 
EXPORT_SPEC int UpnpSearchAsyncUnicast(
    UpnpClient_Handle Hnd,
    const std::string& url,
    const char *Target,
    void *cookie); 
 
EXPORT_SPEC int UpnpSendAdvertisement(
    UpnpDevice_Handle Hnd,
    int Exp);
 
EXPORT_SPEC int UpnpSendAdvertisementLowPower(
    UpnpDevice_Handle Hnd,
    int Exp,
    int PowerState,
    int SleepPeriod,
    int RegistrationState);
 
/******************************************************************************
 *                                                                            *
 *                            C O N T R O L                                   *
 *                                                                            *
 ******************************************************************************/
EXPORT_SPEC int UpnpSendAction(
    UpnpClient_Handle Hnd,
    const std::string& headerString,
    const std::string& actionURL,
    const std::string& serviceType,
    const std::string& actionName,
    const std::vector<std::pair<std::string, std::string>>& actionParams,
    std::vector<std::pair<std::string, std::string>>& responseData,
    int* errcodep,
    std::string& errdesc);
 
/******************************************************************************
 *                                                                            *
 *                        E V E N T I N G                                     *
 *                                                                            *
 ******************************************************************************/
 
EXPORT_SPEC int UpnpAcceptSubscription(
    UpnpDevice_Handle Hnd,
    const char *DevID,
    const char *ServName,
    const char **VarName,
    const char **NewVal,
    int cVariables,
    const Upnp_SID& SubsId);
 
EXPORT_SPEC int UpnpAcceptSubscriptionXML(
    UpnpDevice_Handle Hnd,
    const char *DevID,
    const char *ServName,
    const std::string& propertyset,
    const Upnp_SID& SubsId);
 
EXPORT_SPEC int UpnpNotify(
    UpnpDevice_Handle,
    const char *DevID,
    const char *ServName,
    const char **VarName,
    const char **NewVal,
    int cVariables);
 
EXPORT_SPEC int UpnpNotifyXML(
    UpnpDevice_Handle,
    const char *DevID,
    const char *ServName,
    const std::string& propset);
 
EXPORT_SPEC int UpnpSetMaxSubscriptions(  
    UpnpDevice_Handle Hnd,
    int MaxSubscriptions);
 
EXPORT_SPEC int UpnpSubscribe(
    UpnpClient_Handle Hnd,
    const char *EvtUrl,
    int *TimeOut,
    Upnp_SID& SubsId);
 
EXPORT_SPEC int UpnpRenewSubscription(
    UpnpClient_Handle Hnd,
    int *TimeOut,
    const Upnp_SID& SubsId);
 
EXPORT_SPEC int UpnpUnSubscribe(
    UpnpClient_Handle Hnd,
    const Upnp_SID& SubsId);
 
EXPORT_SPEC int UpnpSetMaxSubscriptionTimeOut(  
    UpnpDevice_Handle Hnd,
    int MaxSubscriptionTimeOut);
 
EXPORT_SPEC int UpnpSubsOpsTimeoutMs(
    UpnpClient_Handle Hnd,
    int TimeOutMS);
 
EXPORT_SPEC int UpnpDownloadUrlItem(
    const char *url,
    char **outBuf,
    char *contentType);
 
EXPORT_SPEC int UpnpDownloadUrlItem(
    const std::string& url,
    std::string& data,
    std::string& ct);
 
/******************************************************************************
 *                                                                            *
 *                    W E B  S E R V E R  A P I                               *
 *                                                                            *
 ******************************************************************************/
 
EXPORT_SPEC int UpnpEnableWebserver(
    int enable);
 
EXPORT_SPEC int UpnpIsWebserverEnabled(void);
 
EXPORT_SPEC int UpnpSetWebServerRootDir( 
    const char *rootDir);
 
EXPORT_SPEC std::string UpnpGetUrlHostPortForClient(const struct sockaddr_storage*);
 
/*
 * @brief Callback for validating HTTP requests HOST header values.
 *
 * This is called when a GET/POST/HEAD request to the Web server contains a host
 * name (instead of a numeric address) in the HOST header. The client code can chose
 * to authorize the request. Else it will be either redirected to a numeric
 * address or rejected depending on the UPNP_FLAG_REJECT_HOSTNAMES
 * option. Specific UPnP (SOAP/SUBSCRIBE...) requests are always checked to
 * contain a numeric address and will not trigger the callback.
 *
 * @param hostname the value in the request HOST header.
 * @return An integer representing one of the following:
 *     \li \c UPNP_E_SUCCESS: a request with the HOST header set to hostname should be processed.
 *     \li \c UPNP_E_BAD_HTTPMSG the request should be redirected or rejected.
 */
typedef int (*WebCallback_HostValidate)(const char *hostname, void *cookie);
 
EXPORT_SPEC int UpnpSetWebRequestHostValidateCallback(
    WebCallback_HostValidate callback, void *cookie);
 
EXPORT_SPEC int UpnpSetHostValidateCallback(
    WebCallback_HostValidate callback, void *cookie);
 
EXPORT_SPEC int UpnpSetWebServerCorsString(
    const char *corsString);
 
 
typedef void *UpnpWebFileHandle;
 
typedef int (*VDCallback_GetInfo)(
    const char *filename,
    struct File_Info *info,
    const void *cookie,
    const void **request_cookiep
    );
 
EXPORT_SPEC int UpnpVirtualDir_set_GetInfoCallback(VDCallback_GetInfo callback);
 
typedef UpnpWebFileHandle (*VDCallback_Open)(
    const char *filename,
    enum UpnpOpenFileMode Mode,
    const void *cookie,
    const void *request_cookie
    );
 
EXPORT_SPEC int UpnpVirtualDir_set_OpenCallback(VDCallback_Open callback);
 
typedef int (*VDCallback_Read)(
    UpnpWebFileHandle fileHnd,
    char *buf,
    size_t buflen,
    const void *cookie,
    const void *request_cookie
    );
 
EXPORT_SPEC int UpnpVirtualDir_set_ReadCallback(VDCallback_Read callback);
 
typedef    int (*VDCallback_Write)(
    UpnpWebFileHandle fileHnd,
    char *buf,
    size_t buflen,
    const void *cookie,
    const void *request_cookie
    );
 
EXPORT_SPEC int UpnpVirtualDir_set_WriteCallback(VDCallback_Write callback);
 
typedef int (*VDCallback_Seek) (
    UpnpWebFileHandle fileHnd,
    int64_t offset,
    int origin,
    const void *cookie,
    const void *request_cookie
    );
 
EXPORT_SPEC int UpnpVirtualDir_set_SeekCallback(VDCallback_Seek callback);
 
typedef int (*VDCallback_Close)(
    UpnpWebFileHandle fileHnd,
    const void *cookie,
    const void *request_cookie
    );
 
EXPORT_SPEC int UpnpVirtualDir_set_CloseCallback(VDCallback_Close callback);
 
struct UpnpVirtualDirCallbacks
{
    VDCallback_GetInfo get_info;
    VDCallback_Open open;
    VDCallback_Read read;
    VDCallback_Write write;
    VDCallback_Seek seek;
    VDCallback_Close close;
};
 
EXPORT_SPEC int UpnpSetVirtualDirCallbacks(
    struct UpnpVirtualDirCallbacks *callbacks );
 
EXPORT_SPEC int UpnpAddVirtualDir(
    const char *dirName, const void *cookie, const void **oldcookie);
 
EXPORT_SPEC int UpnpRemoveVirtualDir(
    const char *dirName);
 
EXPORT_SPEC void UpnpRemoveAllVirtualDirs(void);
 
/* @} Web Server API */
 
#endif /* UPNP_H */