VLC  4.0.0-dev
vlc_httpd.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * vlc_httpd.h: builtin HTTP/RTSP server.
3  *****************************************************************************
4  * Copyright (C) 2004-2006 VLC authors and VideoLAN
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22 
23 #ifndef VLC_HTTPD_H
24 #define VLC_HTTPD_H 1
25 
26 /**
27  * \file
28  * HTTP/RTSP server API.
29  */
30 
31 enum
32 {
34 
35  /* answer */
37 
38  /* http request */
42 
43  /* rtsp request */
51 
52  /* just to track the count of MSG */
54 };
55 
56 enum
57 {
59  HTTPD_PROTO_HTTP, /* HTTP/1.x */
60  HTTPD_PROTO_RTSP, /* RTSP/1.x */
61  HTTPD_PROTO_HTTP0, /* HTTP/0.x */
62 };
63 
64 typedef struct httpd_host_t httpd_host_t;
65 typedef struct httpd_client_t httpd_client_t;
66 /* create a new host */
70 /* delete a host */
72 
73 typedef struct
74 {
75  char * name;
76  char * value;
78 
79 typedef struct httpd_message_t
80 {
81  httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
82 
83  uint8_t i_type;
84  uint8_t i_proto;
85  uint8_t i_version;
86 
87  /* for an answer */
88  int i_status;
89 
90  /* for a query */
91  char *psz_url;
92  /* FIXME find a clean way to handle GET(psz_args)
93  and POST(body) through the same code */
94  uint8_t *psz_args;
95 
96  /* options */
97  size_t i_headers;
99 
100  /* body */
101  int64_t i_body_offset;
102  int i_body;
103  uint8_t *p_body;
104 
106 
107 typedef struct httpd_url_t httpd_url_t;
109 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
110 /* register a new url */
111 VLC_API httpd_url_t * httpd_UrlNew( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password ) VLC_USED;
112 /* register callback on a url */
114 /* delete a url */
116 
117 VLC_API char* httpd_ClientIP( const httpd_client_t *cl, char *, int * );
118 VLC_API char* httpd_ServerIP( const httpd_client_t *cl, char *, int * );
119 
120 /* High level */
121 
122 typedef struct httpd_file_t httpd_file_t;
123 typedef struct httpd_file_sys_t httpd_file_sys_t;
124 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
125 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;
127 
128 
129 typedef struct httpd_handler_t httpd_handler_t;
130 typedef int (*httpd_handler_callback_t)( void *, 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 );
131 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, void * ) VLC_USED;
133 
134 typedef struct httpd_redirect_t httpd_redirect_t;
135 VLC_API httpd_redirect_t * httpd_RedirectNew( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) VLC_USED;
137 
138 
139 typedef struct httpd_stream_t httpd_stream_t;
140 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;
142 VLC_API int httpd_StreamHeader( httpd_stream_t *, uint8_t *p_data, int i_data );
143 VLC_API int httpd_StreamSend( httpd_stream_t *, const block_t *p_block );
145 
146 /* Msg functions facilities */
147 VLC_API void httpd_MsgAdd( httpd_message_t *, const char *psz_name, const char *psz_value, ... ) VLC_FORMAT( 3, 4 );
148 /* return "" if not found. The string is not allocated */
149 VLC_API const char * httpd_MsgGet( const httpd_message_t *, const char *psz_name );
150 
151 #endif /* _VLC_HTTPD_H */
#define VLC_USED
Definition: fourcc_gen.c:32
#define VLC_API
Definition: fourcc_gen.c:31
#define VLC_FORMAT(x, y)
String format function annotation.
Definition: vlc_common.h:211
const char name[16]
Definition: httpd.c:1267
int i_type
Definition: httpd.c:1268
const char * psz_mime
Definition: image.c:633
Definition: httpd.c:141
Definition: httpd.c:300
Definition: httpd.c:405
httpd_handler_callback_t pf_fill
Definition: httpd.c:408
Definition: vlc_httpd.h:75
Definition: httpd.c:76
Definition: vlc_httpd.h:81
httpd_client_t * cl
Definition: vlc_httpd.h:82
httpd_header * p_headers
Definition: vlc_httpd.h:99
int i_body
Definition: vlc_httpd.h:103
int64_t i_body_offset
Definition: vlc_httpd.h:102
uint8_t i_version
Definition: vlc_httpd.h:86
uint8_t i_type
Definition: vlc_httpd.h:84
int i_status
Definition: vlc_httpd.h:89
uint8_t i_proto
Definition: vlc_httpd.h:85
char * psz_url
Definition: vlc_httpd.h:92
uint8_t * psz_args
Definition: vlc_httpd.h:95
uint8_t * p_body
Definition: vlc_httpd.h:104
size_t i_headers
Definition: vlc_httpd.h:98
Definition: httpd.c:524
Definition: httpd.c:597
Definition: httpd.c:107
Definition: vlc_frame.h:123
VLC object common members.
Definition: vlc_objects.h:45
const char * psz_name
Definition: text_style.c:33
const char * httpd_MsgGet(const httpd_message_t *, const char *psz_name)
Definition: httpd.c:1171
int(* httpd_callback_t)(httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query)
Definition: vlc_httpd.h:110
@ HTTPD_MSG_HEAD
Definition: vlc_httpd.h:41
@ HTTPD_MSG_GETPARAMETER
Definition: vlc_httpd.h:50
@ HTTPD_MSG_NONE
Definition: vlc_httpd.h:34
@ HTTPD_MSG_PAUSE
Definition: vlc_httpd.h:49
@ HTTPD_MSG_PLAY
Definition: vlc_httpd.h:48
@ HTTPD_MSG_ANSWER
Definition: vlc_httpd.h:37
@ HTTPD_MSG_SETUP
Definition: vlc_httpd.h:47
@ HTTPD_MSG_MAX
Definition: vlc_httpd.h:54
@ HTTPD_MSG_DESCRIBE
Definition: vlc_httpd.h:46
@ HTTPD_MSG_TEARDOWN
Definition: vlc_httpd.h:51
@ HTTPD_MSG_GET
Definition: vlc_httpd.h:40
@ HTTPD_MSG_POST
Definition: vlc_httpd.h:42
@ HTTPD_MSG_OPTIONS
Definition: vlc_httpd.h:45
struct httpd_message_t httpd_message_t
struct httpd_file_sys_t httpd_file_sys_t
Definition: vlc_httpd.h:124
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, void *) VLC_USED
Definition: httpd.c:483
int httpd_StreamSetHTTPHeaders(httpd_stream_t *, const httpd_header *, size_t)
Definition: httpd.c:2066
char * httpd_ClientIP(const httpd_client_t *cl, char *, int *)
Definition: httpd.c:1207
void httpd_UrlDelete(httpd_url_t *)
Definition: httpd.c:1113
void httpd_StreamDelete(httpd_stream_t *)
Definition: httpd.c:866
httpd_host_t * vlc_http_HostNew(vlc_object_t *) VLC_USED
Definition: httpd.c:889
httpd_redirect_t * httpd_RedirectNew(httpd_host_t *, const char *psz_url_dst, const char *psz_url_src) VLC_USED
Definition: httpd.c:559
void httpd_MsgAdd(httpd_message_t *, const char *psz_name, const char *psz_value,...)
Definition: httpd.c:1179
httpd_host_t * vlc_https_HostNew(vlc_object_t *) VLC_USED
Definition: httpd.c:894
@ HTTPD_PROTO_NONE
Definition: vlc_httpd.h:59
@ HTTPD_PROTO_HTTP0
Definition: vlc_httpd.h:62
@ HTTPD_PROTO_HTTP
Definition: vlc_httpd.h:60
@ HTTPD_PROTO_RTSP
Definition: vlc_httpd.h:61
int httpd_StreamHeader(httpd_stream_t *, uint8_t *p_data, int i_data)
Definition: httpd.c:811
void httpd_RedirectDelete(httpd_redirect_t *)
Definition: httpd.c:587
struct httpd_callback_sys_t httpd_callback_sys_t
Definition: vlc_httpd.h:109
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
Definition: httpd.c:751
void httpd_HostDelete(httpd_host_t *)
Definition: httpd.c:1009
int httpd_UrlCatch(httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t *)
Definition: httpd.c:1101
httpd_file_sys_t * httpd_FileDelete(httpd_file_t *)
Definition: httpd.c:392
char * httpd_ServerIP(const httpd_client_t *cl, char *, int *)
Definition: httpd.c:1212
int(* httpd_file_callback_t)(httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data)
Definition: vlc_httpd.h:125
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
Definition: httpd.c:357
int httpd_StreamSend(httpd_stream_t *, const block_t *p_block)
Definition: httpd.c:845
httpd_host_t * vlc_rtsp_HostNew(vlc_object_t *) VLC_USED
Definition: httpd.c:918
httpd_url_t * httpd_UrlNew(httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password) VLC_USED
Definition: httpd.c:1041
int(* httpd_handler_callback_t)(void *, 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)
Definition: vlc_httpd.h:131
void * httpd_HandlerDelete(httpd_handler_t *)
Definition: httpd.c:512
char psz_value[8]
Definition: vout_intf.c:99