libUPnP 2.0.1
webserver.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 GENLIB_NET_HTTP_WEBSERVER_H
33#define GENLIB_NET_HTTP_WEBSERVER_H
34
35#include "UpnpGlobal.h"
36#include "httpparser.h"
37#include "sock.h"
38#include <time.h>
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
45{
46 int IsVirtualFile;
47 int IsChunkActive;
48 int IsRangeActive;
49 int IsTrailers;
50 char RangeHeader[200];
51 char AcceptLanguageHeader[200];
52 off_t RangeOffset;
58 const void *CorsHeader;
60 const void *Cookie;
62 const void *RequestCookie;
63 /* Later few more member could be added depending
64 * on the requirement.*/
65};
66
78int web_server_init(void);
79
85void web_server_destroy(void);
86
100 const char *alias_name,
103 const char *alias_content,
105 size_t alias_content_length,
108 time_t last_modified);
109
119 const char *root_dir);
120
129 const char *cors_string);
130
137 http_parser_t *parser,
139 http_message_t *req,
141 SOCKINFO *info);
142
143/* regression: issue #153 — unit-test hooks to simulate concurrent alias access
144 */
145UPNP_EXPORT_SPEC void web_server_ut_grab_alias(void);
146UPNP_EXPORT_SPEC void web_server_ut_release_alias(void);
147UPNP_EXPORT_SPEC int web_server_ut_set_alias(
148 const char *name, const char *content, size_t len);
149
150#ifdef __cplusplus
151} /* extern C */
152#endif
153
154#endif /* GENLIB_NET_HTTP_WEBSERVER_H */
Defines constants that for some reason are not defined on some systems.
#define UPNP_EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition UpnpGlobal.h:101
Definition sock.h:60
Definition webserver.h:45
const void * CorsHeader
Definition webserver.h:58
long RecvWriteSize
Definition webserver.h:56
off_t ReadSendSize
Definition webserver.h:54
const void * RequestCookie
Definition webserver.h:62
const void * Cookie
Definition webserver.h:60
Definition httpparser.h:181
Definition httpparser.h:216
int web_server_init()
Initilialize the different documents. Initialize the memory for root directory for web server....
Definition webserver.c:511
int web_server_set_root_dir(const char *root_dir)
Assign the path specfied by the input const char* root_dir parameter to the global Document root dire...
Definition webserver.c:634
int web_server_set_cors(const char *cors_string)
Assign the Access-Control-Allow-Origin specfied by the input const char* cors_string parameterto the ...
Definition webserver.c:652
void web_server_destroy(void)
Release memory allocated for the global web server root directory and the global XML document....
Definition webserver.c:540
int web_server_set_alias(const char *alias_name, const char *alias_content, size_t alias_content_length, time_t last_modified)
Replaces current alias with the given alias. To remove the current alias, set alias_name to NULL.
Definition webserver.c:433
void web_server_callback(http_parser_t *parser, http_message_t *req, SOCKINFO *info)
Main entry point into web server; Handles HTTP GET and HEAD requests.
Definition webserver.c:1762