1 /*****************************************************************************
2 * vlc_httpd.h: builtin HTTP/RTSP server.
3 *****************************************************************************
4 * Copyright (C) 2004 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
25 #define _VLC_HTTPD_H 1
27 /* NEVER touch that, it's here only because src/misc/objects.c
28 * need sizeof(httpd_t) */
44 /* channel communication */
60 /* just to track the count of MSG */
71 struct httpd_message_t
73 httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
85 /* FIXME find a clean way to handle GET(psz_args)
86 and POST(body) through the same code */
89 /* for rtp over rtsp */
99 int64_t i_body_offset;
105 /* I keep the definition here, easier than looking at vlc_common.h
107 * answer could be null, int this case no answer is requested
108 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
109 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
111 typedef struct httpd_file_t httpd_file_t;
112 typedef struct httpd_file_sys_t httpd_file_sys_t;
113 typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
116 /* create a new host */
117 VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, const char *psz_host, int i_port ) );
118 VLC_EXPORT( httpd_host_t *, httpd_TLSHostNew, ( vlc_object_t *, const char *, int, const char *, const char *, const char *, const char * ) );
121 VLC_EXPORT( void, httpd_HostDelete, ( httpd_host_t * ) );
123 /* register a new url */
124 VLC_EXPORT( httpd_url_t *, httpd_UrlNew, ( httpd_host_t *, char *psz_url, char *psz_user, char *psz_password, const vlc_acl_t *p_acl ) );
125 VLC_EXPORT( httpd_url_t *, httpd_UrlNewUnique, ( httpd_host_t *, char *psz_url, char *psz_user, char *psz_password, const vlc_acl_t *p_acl ) );
126 /* register callback on a url */
127 VLC_EXPORT( int, httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) );
129 VLC_EXPORT( void, httpd_UrlDelete, ( httpd_url_t * ) );
131 /* Default client mode is FILE, use these to change it */
132 VLC_EXPORT( void, httpd_ClientModeStream, ( httpd_client_t *cl ) );
133 VLC_EXPORT( void, httpd_ClientModeBidir, ( httpd_client_t *cl ) );
134 VLC_EXPORT( char*, httpd_ClientIP, ( httpd_client_t *cl, char *psz_ip ) );
135 VLC_EXPORT( char*, httpd_ServerIP, ( httpd_client_t *cl, char *psz_ip ) );
139 VLC_EXPORT( httpd_file_t *, httpd_FileNew, ( httpd_host_t *, char *psz_url, char *psz_mime, char *psz_user, char *psz_password, const vlc_acl_t *p_acl, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) );
140 VLC_EXPORT( void, httpd_FileDelete, ( httpd_file_t * ) );
143 VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, char *psz_url_dst, char *psz_url_src ) );
144 VLC_EXPORT( void, httpd_RedirectDelete, ( httpd_redirect_t * ) );
147 VLC_EXPORT( httpd_stream_t *, httpd_StreamNew, ( httpd_host_t *, char *psz_url, char *psz_mime, char *psz_user, char *psz_password, const vlc_acl_t *p_acl ) );
148 VLC_EXPORT( void, httpd_StreamDelete, ( httpd_stream_t * ) );
149 VLC_EXPORT( int, httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
150 VLC_EXPORT( int, httpd_StreamSend, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
153 /* Msg functions facilities */
154 VLC_EXPORT( void, httpd_MsgInit, ( httpd_message_t * ) );
155 VLC_EXPORT( void, httpd_MsgAdd, ( httpd_message_t *, char *psz_name, char *psz_value, ... ) );
156 /* return "" if not found. The string is not allocated */
157 VLC_EXPORT( char *, httpd_MsgGet, ( httpd_message_t *, char *psz_name ) );
158 VLC_EXPORT( void, httpd_MsgClean, ( httpd_message_t * ) );
160 #endif /* _VLC_HTTPD_H */