X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_httpd.h;h=6100dd00b2f1a1c957224c5d0af0791ace64551a;hb=099e253c24363da7194d49bc24f2208baf07adcf;hp=cd95b7f6fbe0e17ef0a5aa728227a6e70666ee7b;hpb=2d4c56cd959c58efb6200487bd0e1edf33fa5e9d;p=vlc diff --git a/include/vlc_httpd.h b/include/vlc_httpd.h index cd95b7f6fb..6100dd00b2 100644 --- a/include/vlc_httpd.h +++ b/include/vlc_httpd.h @@ -1,38 +1,33 @@ /***************************************************************************** * vlc_httpd.h: builtin HTTP/RTSP server. ***************************************************************************** - * Copyright (C) 2004 VideoLAN - * $Id: vlc_httpd.h,v 1.1 2004/03/03 13:23:47 fenrir Exp $ + * Copyright (C) 2004-2006 VLC authors and VideoLAN + * $Id$ * * Authors: Laurent Aimar * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#ifndef _VLC_HTTPD_H -#define _VLC_HTTPD_H 1 +#ifndef VLC_HTTPD_H +#define VLC_HTTPD_H 1 -/* NEVER touch that, it's here only because src/misc/objects.c - * need sizeof(httpd_t) */ -struct httpd_t -{ - VLC_COMMON_MEMBERS - - int i_host; - httpd_host_t **host; -}; +/** + * \file + * HTTP/RTSP server API. + */ enum { @@ -41,9 +36,6 @@ enum /* answer */ HTTPD_MSG_ANSWER, - /* channel communication */ - HTTPD_MSG_CHANNEL, - /* http request */ HTTPD_MSG_GET, HTTPD_MSG_HEAD, @@ -55,6 +47,7 @@ enum HTTPD_MSG_SETUP, HTTPD_MSG_PLAY, HTTPD_MSG_PAUSE, + HTTPD_MSG_GETPARAMETER, HTTPD_MSG_TEARDOWN, /* just to track the count of MSG */ @@ -64,28 +57,36 @@ enum enum { HTTPD_PROTO_NONE, - HTTPD_PROTO_HTTP, - HTTPD_PROTO_RTSP, + HTTPD_PROTO_HTTP, /* HTTP/1.x */ + HTTPD_PROTO_RTSP, /* RTSP/1.x */ + HTTPD_PROTO_HTTP0, /* HTTP/0.x */ }; -struct httpd_message_t +typedef struct httpd_host_t httpd_host_t; +typedef struct httpd_client_t httpd_client_t; +/* create a new host */ +VLC_API httpd_host_t *vlc_http_HostNew( vlc_object_t * ) VLC_USED; +VLC_API httpd_host_t *vlc_https_HostNew( vlc_object_t * ) VLC_USED; +VLC_API httpd_host_t *vlc_rtsp_HostNew( vlc_object_t * ) VLC_USED; +/* delete a host */ +VLC_API void httpd_HostDelete( httpd_host_t * ); + +typedef struct httpd_message_t { httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */ - int i_type; - int i_proto; - int i_version; + uint8_t i_type; + uint8_t i_proto; + uint8_t i_version; /* for an answer */ int i_status; - char *psz_status; /* for a query */ char *psz_url; - char *psz_args; /* FIXME find a clean way to handle GET(psz_args) and POST(body) through the same code */ - - /* for rtp over rtsp */ - int i_channel; + /* FIXME find a clean way to handle GET(psz_args) + and POST(body) through the same code */ + uint8_t *psz_args; /* options */ int i_name; @@ -98,57 +99,51 @@ struct httpd_message_t int i_body; uint8_t *p_body; -}; - -/* I keep the definition here, easier than looking at vlc_common.h +} httpd_message_t; - * answer could be null, int this case no answer is requested -typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query ); +typedef struct httpd_url_t httpd_url_t; typedef struct httpd_callback_sys_t httpd_callback_sys_t; - -typedef struct httpd_file_t httpd_file_t; -typedef struct httpd_file_sys_t httpd_file_sys_t; -typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data ); -*/ - -/* create a new host */ -VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, char *psz_host, int i_port ) ); -/* delete a host */ -VLC_EXPORT( void, httpd_HostDelete, ( httpd_host_t * ) ); - +typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query ); /* register a new url */ -VLC_EXPORT( httpd_url_t *, httpd_UrlNew, ( httpd_host_t *, char *psz_url, char *psz_user, char *psz_password ) ); -VLC_EXPORT( httpd_url_t *, httpd_UrlNewUnique, ( httpd_host_t *, char *psz_url, char *psz_user, char *psz_password ) ); +VLC_API httpd_url_t * httpd_UrlNew( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password ) VLC_USED; /* register callback on a url */ -VLC_EXPORT( int, httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) ); -/* delete an url */ -VLC_EXPORT( void, httpd_UrlDelete, ( httpd_url_t * ) ); +VLC_API int httpd_UrlCatch( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ); +/* delete a url */ +VLC_API void httpd_UrlDelete( httpd_url_t * ); -/* Default client mode is FILE, use these to change it */ -VLC_EXPORT( void, httpd_ClientModeStream, ( httpd_client_t *cl ) ); -VLC_EXPORT( void, httpd_ClientModeBidir, ( httpd_client_t *cl ) ); +VLC_API char* httpd_ClientIP( const httpd_client_t *cl, char *, int * ); +VLC_API char* httpd_ServerIP( const httpd_client_t *cl, char *, int * ); /* High level */ -VLC_EXPORT( httpd_file_t *, httpd_FileNew, ( httpd_host_t *, char *psz_url, char *psz_mime, char *psz_user, char *psz_password, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) ); -VLC_EXPORT( void, httpd_FileDelete, ( httpd_file_t * ) ); +typedef struct httpd_file_t httpd_file_t; +typedef struct httpd_file_sys_t httpd_file_sys_t; +typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data ); +VLC_API httpd_file_t * httpd_FileNew( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) VLC_USED; +VLC_API httpd_file_sys_t * httpd_FileDelete( httpd_file_t * ); + +typedef struct httpd_handler_t httpd_handler_t; +typedef struct httpd_handler_sys_t httpd_handler_sys_t; +typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data ); +VLC_API httpd_handler_t * httpd_HandlerNew( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, httpd_handler_callback_t pf_fill, httpd_handler_sys_t * ) VLC_USED; +VLC_API httpd_handler_sys_t * httpd_HandlerDelete( httpd_handler_t * ); -VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, char *psz_url_dst, char *psz_url_src ) ); -VLC_EXPORT( void, httpd_RedirectDelete, ( httpd_redirect_t * ) ); +typedef struct httpd_redirect_t httpd_redirect_t; +VLC_API httpd_redirect_t * httpd_RedirectNew( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) VLC_USED; +VLC_API void httpd_RedirectDelete( httpd_redirect_t * ); -VLC_EXPORT( httpd_stream_t *, httpd_StreamNew, ( httpd_host_t *, char *psz_url, char *psz_mime, char *psz_user, char *psz_password ) ); -VLC_EXPORT( void, httpd_StreamDelete, ( httpd_stream_t * ) ); -VLC_EXPORT( int, httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) ); -VLC_EXPORT( int, httpd_StreamSend, ( httpd_stream_t *, uint8_t *p_data, int i_data ) ); +typedef struct httpd_stream_t httpd_stream_t; +VLC_API httpd_stream_t * httpd_StreamNew( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password ) VLC_USED; +VLC_API void httpd_StreamDelete( httpd_stream_t * ); +VLC_API int httpd_StreamHeader( httpd_stream_t *, uint8_t *p_data, int i_data ); +VLC_API int httpd_StreamSend( httpd_stream_t *, uint8_t *p_data, int i_data ); /* Msg functions facilities */ -VLC_EXPORT( void, httpd_MsgInit, ( httpd_message_t * ) ); -VLC_EXPORT( void, httpd_MsgAdd, ( httpd_message_t *, char *psz_name, char *psz_value, ... ) ); +VLC_API void httpd_MsgAdd( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) VLC_FORMAT( 3, 4 ); /* return "" if not found. The string is not allocated */ -VLC_EXPORT( char *, httpd_MsgGet, ( httpd_message_t *, char *psz_name ) ); -VLC_EXPORT( void, httpd_MsgClean, ( httpd_message_t * ) ); +VLC_API const char * httpd_MsgGet( const httpd_message_t *, const char *psz_name ); #endif /* _VLC_HTTPD_H */