libUPnP  1.14.24
urlconfig.h
1 /**************************************************************************
2  *
3  * Copyright (c) 2000-2003 Intel Corporation
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * - Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * - Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  * - Neither name of Intel Corporation nor the names of its contributors
15  * may be used to endorse or promote products derived from this software
16  * without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  **************************************************************************/
31 
32 #ifndef URLCONFIG_H
33 #define URLCONFIG_H
34 
35 #include "UpnpInet.h"
36 
37 /* functions available only if the web server is included */
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /************************************************************************
44  * Function: configure_urlbase
45  *
46  * Parameters :
47  * INOUT IXML_Document *doc ; IXML Description document
48  * IN const struct sockaddr *serverAddr; socket address object
49  * providing the IP address and port information
50  * IN const char* alias ; string containing the alias
51  * IN time_t last_modified ; time when the XML document was
52  * downloaded
53  * OUT char docURL[LINE_SIZE] ; buffer to hold the URL of the
54  * document.
55  *
56  * Description : Configure the full URL for the description document.
57  * Create the URL document and add alias, description information.
58  * The doc is added to the web server to be served using the given
59  * alias.
60  *
61  * Return : int ;
62  * UPNP_E_SUCCESS - On Success
63  * UPNP_E_OUTOF_MEMORY - Default Error
64  ****************************************************************************/
65 int configure_urlbase(IXML_Document *doc,
66  const struct sockaddr *serverAddr,
67  const char *alias,
68  time_t last_modified,
69  char docURL[LINE_SIZE]);
70 
71 #ifdef __cplusplus
72 } /* extern C */
73 #endif
74 
75 #endif /* URLCONFIG_H */
Provides a platform independent way to include TCP/IP types and functions.
Data structure representing the DOM Document.
Definition: ixml.h:159