VLC 4.0.0-dev
Loading...
Searching...
No Matches
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
31enum
32{
35 /* answer */
38 /* http request */
43 /* rtsp request */
52 /* just to track the count of MSG */
54};
56enum
57{
59 HTTPD_PROTO_HTTP, /* HTTP/1.x */
60 HTTPD_PROTO_RTSP, /* RTSP/1.x */
61 HTTPD_PROTO_HTTP0, /* HTTP/0.x */
62};
63
64typedef struct httpd_host_t httpd_host_t;
66/* create a new host */
70/* delete a host */
72
73typedef struct
75 char * name;
76 char * value;
78
79typedef struct httpd_message_t
81 httpd_client_t *cl; /* NULL if not through a connection e vlc internal */
83 uint8_t i_type;
84 uint8_t i_proto;
85 uint8_t i_version;
87 /* for an answer */
88 int i_status;
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;
96 /* options */
97 size_t i_headers;
100 /* body */
101 int64_t i_body_offset;
102 size_t i_body;
103 uint8_t *p_body;
107typedef struct httpd_url_t httpd_url_t;
110/* register a new url */
111VLC_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
117VLC_API char* httpd_ClientIP( const httpd_client_t *cl, char *, int * );
118VLC_API char* httpd_ServerIP( const httpd_client_t *cl, char *, int * );
119
120/* High level */
121
122typedef struct httpd_file_t httpd_file_t;
124typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, size_t *pi_data );
125VLC_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
129typedef struct httpd_handler_t httpd_handler_t;
130typedef 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, size_t *pi_data );
131VLC_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
135VLC_API httpd_redirect_t * httpd_RedirectNew( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) VLC_USED;
137
138
139typedef struct httpd_stream_t httpd_stream_t;
140VLC_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;
142VLC_API int httpd_StreamHeader( httpd_stream_t *, uint8_t *p_data, int i_data );
143VLC_API int httpd_StreamSend( httpd_stream_t *, const block_t *p_block );
145
146/* Msg functions facilities */
147VLC_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 */
149VLC_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:193
const char name[16]
Definition httpd.c:1298
int i_type
Definition httpd.c:1299
const char * psz_mime
Definition image.c:619
Definition httpd.c:143
Definition httpd.c:318
Definition httpd.c:422
httpd_handler_callback_t pf_fill
Definition httpd.c:425
Definition vlc_httpd.h:75
char * name
Definition vlc_httpd.h:76
char * value
Definition vlc_httpd.h:77
Definition httpd.c:78
Definition vlc_httpd.h:81
httpd_client_t * cl
Definition vlc_httpd.h:82
httpd_header * p_headers
Definition vlc_httpd.h:99
int64_t i_body_offset
Definition vlc_httpd.h:102
uint8_t i_version
Definition vlc_httpd.h:86
size_t i_body
Definition vlc_httpd.h:103
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:555
Definition httpd.c:628
Definition httpd.c:109
Definition vlc_frame.h:123
VLC object common members.
Definition vlc_objects.h:53
const char * psz_name
Definition text_style.c:33
This file is a collection of common definitions and types.
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_host_t * vlc_http_HostNew(vlc_object_t *)
Definition httpd.c:920
struct httpd_file_sys_t httpd_file_sys_t
Definition vlc_httpd.h:124
void * httpd_HandlerDelete(httpd_handler_t *)
Definition httpd.c:543
int httpd_StreamSetHTTPHeaders(httpd_stream_t *, const httpd_header *, size_t)
Definition httpd.c:2092
void httpd_UrlDelete(httpd_url_t *)
Definition httpd.c:1144
void httpd_StreamDelete(httpd_stream_t *)
Definition httpd.c:897
@ 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
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, size_t *pi_data)
Definition vlc_httpd.h:131
httpd_url_t * httpd_UrlNew(httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password)
Definition httpd.c:1072
char * httpd_ClientIP(const httpd_client_t *cl, char *, int *)
Definition httpd.c:1238
char * httpd_ServerIP(const httpd_client_t *cl, char *, int *)
Definition httpd.c:1243
int(* httpd_file_callback_t)(httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, size_t *pi_data)
Definition vlc_httpd.h:125
void httpd_MsgAdd(httpd_message_t *, const char *psz_name, const char *psz_value,...)
Definition httpd.c:1210
httpd_file_sys_t * httpd_FileDelete(httpd_file_t *)
Definition httpd.c:409
int httpd_StreamHeader(httpd_stream_t *, uint8_t *p_data, int i_data)
Definition httpd.c:842
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 *)
Definition httpd.c:374
@ 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
void httpd_RedirectDelete(httpd_redirect_t *)
Definition httpd.c:618
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 *)
Definition httpd.c:514
struct httpd_callback_sys_t httpd_callback_sys_t
Definition vlc_httpd.h:109
httpd_host_t * vlc_rtsp_HostNew(vlc_object_t *)
Definition httpd.c:949
void httpd_HostDelete(httpd_host_t *)
Definition httpd.c:1040
httpd_stream_t * httpd_StreamNew(httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password)
Definition httpd.c:782
httpd_host_t * vlc_https_HostNew(vlc_object_t *)
Definition httpd.c:925
int httpd_UrlCatch(httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t *)
Definition httpd.c:1132
const char * httpd_MsgGet(const httpd_message_t *, const char *psz_name)
Definition httpd.c:1202
httpd_redirect_t * httpd_RedirectNew(httpd_host_t *, const char *psz_url_dst, const char *psz_url_src)
Definition httpd.c:590
int httpd_StreamSend(httpd_stream_t *, const block_t *p_block)
Definition httpd.c:876
char psz_value[8]
Definition vout_intf.c:100