- Doxygen additions
[asterisk/asterisk.git] / include / asterisk / http.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_HTTP_H
20 #define _ASTERISK_HTTP_H
21
22 #include "asterisk/config.h"
23
24 /*!
25   \file http.h
26   \brief Support for Private Asterisk HTTP Servers.
27   \note Note: The Asterisk HTTP servers are extremely simple and minimal and
28         only support the "GET" method.
29   \author Mark Spencer <markster@digium.com>
30 */
31
32 /*! \brief HTTP Callbacks take the socket, the method and the path as arguments and should
33    return the content, allocated with malloc().  Status should be changed to reflect
34    the status of the request if it isn't 200 and title may be set to a malloc()'d string
35    to an appropriate title for non-200 responses.  Content length may also be specified. 
36    The return value may include additional headers at the front and MUST include a blank 
37    line with \r\n to provide separation between user headers and content (even if no
38    content is specified) */
39 typedef char *(*ast_http_callback)(struct sockaddr_in *requestor, const char *uri, struct ast_variable *params, int *status, char **title, int *contentlength);
40
41 struct ast_http_uri {
42         struct ast_http_uri *next;
43         const char *description;
44         const char *uri;
45         int has_subtree;
46         ast_http_callback callback;
47 };
48
49 /*! \brief Link into the Asterisk HTTP server */
50 int ast_http_uri_link(struct ast_http_uri *urihandler);
51
52 /*! \brief Return a malloc()'d string containing an HTTP error message */
53 char *ast_http_error(int status, const char *title, const char *extra_header, const char *text);
54
55 /*! \brief Destroy an HTTP server */
56 void ast_http_uri_unlink(struct ast_http_uri *urihandler);
57
58 char *ast_http_setcookie(const char *var, const char *val, int expires, char *buf, size_t buflen);
59
60 int ast_http_init(void);
61 int ast_http_reload(void);
62
63 #endif /* _ASTERISK_SRV_H */