Privatize httpd_MsgInit and httpd_MsgClean
[vlc.git] / include / vlc_httpd.h
1 /*****************************************************************************
2  * vlc_httpd.h: builtin HTTP/RTSP server.
3  *****************************************************************************
4  * Copyright (C) 2004-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef VLC_HTTPD_H
25 #define VLC_HTTPD_H 1
26
27 /**
28  * \file
29  * This file defines functions, structures, enums and macros for httpd functionality in vlc.
30  */
31
32 enum
33 {
34     HTTPD_MSG_NONE,
35
36     /* answer */
37     HTTPD_MSG_ANSWER,
38
39     /* channel communication */
40     HTTPD_MSG_CHANNEL,
41
42     /* http request */
43     HTTPD_MSG_GET,
44     HTTPD_MSG_HEAD,
45     HTTPD_MSG_POST,
46
47     /* rtsp request */
48     HTTPD_MSG_OPTIONS,
49     HTTPD_MSG_DESCRIBE,
50     HTTPD_MSG_SETUP,
51     HTTPD_MSG_PLAY,
52     HTTPD_MSG_PAUSE,
53     HTTPD_MSG_GETPARAMETER,
54     HTTPD_MSG_TEARDOWN,
55
56     /* just to track the count of MSG */
57     HTTPD_MSG_MAX
58 };
59
60 enum
61 {
62     HTTPD_PROTO_NONE,
63     HTTPD_PROTO_HTTP,  /* HTTP/1.x */
64     HTTPD_PROTO_RTSP,  /* RTSP/1.x */
65     HTTPD_PROTO_HTTP0, /* HTTP/0.x */
66 };
67
68 struct httpd_message_t
69 {
70     httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
71
72     uint8_t i_type;
73     uint8_t i_proto;
74     uint8_t i_version;
75
76     /* for an answer */
77     int     i_status;
78
79     /* for a query */
80     char    *psz_url;
81     /* FIXME find a clean way to handle GET(psz_args)
82        and POST(body) through the same code */
83     uint8_t *psz_args;
84
85     /* for rtp over rtsp */
86     int     i_channel;
87
88     /* options */
89     int     i_name;
90     char    **name;
91     int     i_value;
92     char    **value;
93
94     /* body */
95     int64_t i_body_offset;
96     int     i_body;
97     uint8_t *p_body;
98
99 };
100
101 /* create a new host */
102 VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, const char *psz_host, int i_port ) );
103 VLC_EXPORT( httpd_host_t *, httpd_TLSHostNew, ( vlc_object_t *, const char *, int, const char *, const char *, const char *, const char * ) );
104
105 /* delete a host */
106 VLC_EXPORT( void,           httpd_HostDelete, ( httpd_host_t * ) );
107
108 /* register a new url */
109 VLC_EXPORT( httpd_url_t *,  httpd_UrlNew, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
110 VLC_EXPORT( httpd_url_t *,  httpd_UrlNewUnique, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
111 /* register callback on a url */
112 VLC_EXPORT( int,            httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) );
113 /* delete an url */
114 VLC_EXPORT( void,           httpd_UrlDelete, ( httpd_url_t * ) );
115
116 /* Default client mode is FILE, use these to change it */
117 VLC_EXPORT( void,           httpd_ClientModeStream, ( httpd_client_t *cl ) );
118 VLC_EXPORT( void,           httpd_ClientModeBidir, ( httpd_client_t *cl ) );
119 VLC_EXPORT( char*,          httpd_ClientIP, ( const httpd_client_t *cl, char *psz_ip ) );
120 VLC_EXPORT( char*,          httpd_ServerIP, ( const httpd_client_t *cl, char *psz_ip ) );
121
122 /* High level */
123
124 VLC_EXPORT( httpd_file_t *, httpd_FileNew, ( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) );
125 VLC_EXPORT( httpd_file_sys_t *, httpd_FileDelete, ( httpd_file_t * ) );
126
127
128 VLC_EXPORT( httpd_handler_t *, httpd_HandlerNew, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl, httpd_handler_callback_t pf_fill, httpd_handler_sys_t * ) );
129 VLC_EXPORT( httpd_handler_sys_t *, httpd_HandlerDelete, ( httpd_handler_t * ) );
130
131
132 VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) );
133 VLC_EXPORT( void,               httpd_RedirectDelete, ( httpd_redirect_t * ) );
134
135
136 VLC_EXPORT( httpd_stream_t *, httpd_StreamNew,    ( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
137 VLC_EXPORT( void,             httpd_StreamDelete, ( httpd_stream_t * ) );
138 VLC_EXPORT( int,              httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
139 VLC_EXPORT( int,              httpd_StreamSend,   ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
140
141
142 /* Msg functions facilities */
143 VLC_EXPORT( void,         httpd_MsgAdd, ( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) LIBVLC_FORMAT( 3, 4 ) );
144 /* return "" if not found. The string is not allocated */
145 VLC_EXPORT( const char *, httpd_MsgGet, ( const httpd_message_t *, const char *psz_name ) );
146
147 #endif /* _VLC_HTTPD_H */