libUPnP 1.8.4
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
33#ifndef URLCONFIG_H
34#define URLCONFIG_H
35
36
37#include "UpnpInet.h"
38
39/* functions available only if the web server is included */
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45
46/************************************************************************
47 * Function: configure_urlbase
48 *
49 * Parameters :
50 * INOUT IXML_Document *doc ; IXML Description document
51 * IN const struct sockaddr *serverAddr; socket address object
52 * providing the IP address and port information
53 * IN const char* alias ; string containing the alias
54 * IN time_t last_modified ; time when the XML document was
55 * downloaded
56 * OUT char docURL[LINE_SIZE] ; buffer to hold the URL of the
57 * document.
58 *
59 * Description : Configure the full URL for the description document.
60 * Create the URL document and add alias, description information.
61 * The doc is added to the web server to be served using the given
62 * alias.
63 *
64 * Return : int ;
65 * UPNP_E_SUCCESS - On Success
66 * UPNP_E_OUTOF_MEMORY - Default Error
67 ****************************************************************************/
68int configure_urlbase( INOUT IXML_Document *doc,
69 IN const struct sockaddr* serverAddr,
70 IN const char* alias,
71 IN time_t last_modified,
72 OUT char docURL[LINE_SIZE]);
73
74
75#ifdef __cplusplus
76} /* extern C */
77#endif
78
79
80#endif /* URLCONFIG_H */
81
Provides a platform independent way to include TCP/IP types and functions.
Data structure representing the DOM Document.
Definition ixml.h:198