libUPnP
1.6.17
|
00001 /************************************************************************** 00002 * 00003 * Copyright (c) 2000-2003 Intel Corporation 00004 * All rights reserved. 00005 * 00006 * Redistribution and use in source and binary forms, with or without 00007 * modification, are permitted provided that the following conditions are met: 00008 * 00009 * - Redistributions of source code must retain the above copyright notice, 00010 * this list of conditions and the following disclaimer. 00011 * - Redistributions in binary form must reproduce the above copyright notice, 00012 * this list of conditions and the following disclaimer in the documentation 00013 * and/or other materials provided with the distribution. 00014 * - Neither name of Intel Corporation nor the names of its contributors 00015 * may be used to endorse or promote products derived from this software 00016 * without specific prior written permission. 00017 * 00018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 00019 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 00020 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 00021 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR 00022 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00023 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00024 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00025 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 00026 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00027 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00029 * 00030 **************************************************************************/ 00031 00032 00033 #ifndef URLCONFIG_H 00034 #define URLCONFIG_H 00035 00036 00037 #include "UpnpInet.h" 00038 00039 /* functions available only if the web server is included */ 00040 00041 #ifdef __cplusplus 00042 extern "C" { 00043 #endif 00044 00045 00046 /************************************************************************ 00047 * Function: configure_urlbase 00048 * 00049 * Parameters : 00050 * INOUT IXML_Document *doc ; IXML Description document 00051 * IN const struct sockaddr *serverAddr; socket address object 00052 * providing the IP address and port information 00053 * IN const char* alias ; string containing the alias 00054 * IN time_t last_modified ; time when the XML document was 00055 * downloaded 00056 * OUT char docURL[LINE_SIZE] ; buffer to hold the URL of the 00057 * document. 00058 * 00059 * Description : Configure the full URL for the description document. 00060 * Create the URL document and add alias, description information. 00061 * The doc is added to the web server to be served using the given 00062 * alias. 00063 * 00064 * Return : int ; 00065 * UPNP_E_SUCCESS - On Success 00066 * UPNP_E_OUTOF_MEMORY - Default Error 00067 ****************************************************************************/ 00068 int configure_urlbase( INOUT IXML_Document *doc, 00069 IN const struct sockaddr* serverAddr, 00070 IN const char* alias, 00071 IN time_t last_modified, 00072 OUT char docURL[LINE_SIZE]); 00073 00074 00075 #ifdef __cplusplus 00076 } /* extern C */ 00077 #endif 00078 00079 00080 #endif /* URLCONFIG_H */ 00081