vlc_httpd.h File Reference

HTTP/RTSP server API. More...

Include dependency graph for vlc_httpd.h:

Go to the source code of this file.

Data Structures
struct	httpd_message_t

Typedefs
typedef struct httpd_host_t	httpd_host_t
typedef struct httpd_client_t	httpd_client_t
typedef struct httpd_message_t	httpd_message_t
typedef struct httpd_url_t	httpd_url_t
typedef struct httpd_callback_sys_t	httpd_callback_sys_t
typedef int(*	httpd_callback_t )(httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query)
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)
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)
typedef struct httpd_redirect_t	httpd_redirect_t
typedef struct httpd_stream_t	httpd_stream_t

Enumerations
enum	{   HTTPD_MSG_NONE, HTTPD_MSG_ANSWER, HTTPD_MSG_GET, HTTPD_MSG_HEAD,   HTTPD_MSG_POST, HTTPD_MSG_OPTIONS, HTTPD_MSG_DESCRIBE, HTTPD_MSG_SETUP,   HTTPD_MSG_PLAY, HTTPD_MSG_PAUSE, HTTPD_MSG_GETPARAMETER, HTTPD_MSG_TEARDOWN,   HTTPD_MSG_MAX }
enum	{ HTTPD_PROTO_NONE, HTTPD_PROTO_HTTP, HTTPD_PROTO_RTSP, HTTPD_PROTO_HTTP0 }

Functions
httpd_host_t *	vlc_http_HostNew (vlc_object_t *)
httpd_host_t *	vlc_https_HostNew (vlc_object_t *)
httpd_host_t *	vlc_rtsp_HostNew (vlc_object_t *)
void	httpd_HostDelete (httpd_host_t *)
httpd_url_t *	httpd_UrlNew (httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password)
int	httpd_UrlCatch (httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t *)
void	httpd_UrlDelete (httpd_url_t *)
char *	httpd_ClientIP (const httpd_client_t *cl, char *, int *)
char *	httpd_ServerIP (const httpd_client_t *cl, char *, int *)
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 *)
httpd_file_sys_t *	httpd_FileDelete (httpd_file_t *)
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 *)
httpd_handler_sys_t *	httpd_HandlerDelete (httpd_handler_t *)
httpd_redirect_t *	httpd_RedirectNew (httpd_host_t *, const char *psz_url_dst, const char *psz_url_src)
void	httpd_RedirectDelete (httpd_redirect_t *)
httpd_stream_t *	httpd_StreamNew (httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password)
void	httpd_StreamDelete (httpd_stream_t *)
int	httpd_StreamHeader (httpd_stream_t *, uint8_t *p_data, int i_data)
int	httpd_StreamSend (httpd_stream_t *, uint8_t *p_data, int i_data)
void	httpd_MsgAdd (httpd_message_t *, const char *psz_name, const char *psz_value,...)
const char *	httpd_MsgGet (const httpd_message_t *, const char *psz_name)

Detailed Description

HTTP/RTSP server API.

Typedef Documentation

typedef struct httpd_callback_sys_t httpd_callback_sys_t

typedef int(* httpd_callback_t)(httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query)

typedef struct httpd_client_t httpd_client_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)

typedef struct httpd_file_sys_t httpd_file_sys_t

typedef struct httpd_file_t httpd_file_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)

typedef struct httpd_handler_sys_t httpd_handler_sys_t

typedef struct httpd_handler_t httpd_handler_t

typedef struct httpd_host_t httpd_host_t

typedef struct httpd_message_t httpd_message_t

typedef struct httpd_redirect_t httpd_redirect_t

typedef struct httpd_stream_t httpd_stream_t

typedef struct httpd_url_t httpd_url_t

Enumeration Type Documentation

anonymous enum

Enumerator:

HTTPD_MSG_NONE
HTTPD_MSG_ANSWER
HTTPD_MSG_GET
HTTPD_MSG_HEAD
HTTPD_MSG_POST
HTTPD_MSG_OPTIONS
HTTPD_MSG_DESCRIBE
HTTPD_MSG_SETUP
HTTPD_MSG_PLAY
HTTPD_MSG_PAUSE
HTTPD_MSG_GETPARAMETER
HTTPD_MSG_TEARDOWN
HTTPD_MSG_MAX

anonymous enum

Enumerator:

HTTPD_PROTO_NONE
HTTPD_PROTO_HTTP
HTTPD_PROTO_RTSP
HTTPD_PROTO_HTTP0

Function Documentation

char* httpd_ClientIP	(	const httpd_client_t *	cl,
		char *	,
		int *
	)

References httpd_client_t::fd, and net_GetPeerAddress().

Referenced by httpd_HandlerCallBack().

httpd_file_sys_t* httpd_FileDelete

(

httpd_file_t *

)

References httpd_UrlDelete(), httpd_file_t::p_sys, httpd_file_t::psz_mime, httpd_file_t::psz_url, and httpd_file_t::url.

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 *
	)

References httpd_FileCallBack(), HTTPD_MSG_GET, HTTPD_MSG_HEAD, HTTPD_MSG_POST, httpd_UrlCatch(), httpd_UrlNew(), httpd_file_t::p_sys, httpd_file_t::pf_fill, httpd_file_t::psz_mime, httpd_file_t::psz_url, strdup(), httpd_file_t::url, vlc_mime_Ext2Mime(), and xmalloc().

httpd_handler_sys_t* httpd_HandlerDelete

(

httpd_handler_t *

)

References httpd_UrlDelete(), httpd_handler_t::p_sys, and httpd_handler_t::url.

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 *
	)

References httpd_HandlerCallBack(), HTTPD_MSG_GET, HTTPD_MSG_HEAD, HTTPD_MSG_POST, httpd_UrlCatch(), httpd_UrlNew(), httpd_handler_t::p_sys, httpd_handler_t::pf_fill, httpd_handler_t::url, and xmalloc().

void httpd_HostDelete

(

httpd_host_t *

)

References httpd_host_t::client, httpd_host_t::fds, httpd::host, httpd_ClientClean(), httpd_host_t::i_client, httpd::i_host, httpd_host_t::i_ref, httpd_host_t::i_url, httpd_host_t::lock, msg_Dbg, msg_Err, msg_Warn, httpd::mutex, net_ListenClose(), httpd_host_t::p_tls, httpd_url_t::psz_url, TAB_REMOVE, httpd_host_t::thread, httpd_host_t::url, vlc_cancel(), vlc_cond_destroy(), vlc_join(), vlc_mutex_destroy(), vlc_mutex_lock(), vlc_mutex_unlock(), vlc_object_release, vlc_tls_Delete(), and httpd_host_t::wait.

void httpd_MsgAdd	(	httpd_message_t *	,
		const char *	psz_name,
		const char *	psz_value,
			...
	)

References httpd_message_t::i_name, httpd_message_t::i_value, httpd_message_t::name, strdup(), TAB_APPEND, us_vasprintf(), and httpd_message_t::value.

Referenced by httpd_FileCallBack(), httpd_HostThread(), httpd_RedirectCallBack(), and httpd_StreamCallBack().

const char* httpd_MsgGet	(	const httpd_message_t *	,
		const char *	psz_name
	)

References httpd_message_t::i_name, httpd_message_t::name, strcasecmp(), and httpd_message_t::value.

Referenced by httpd_FileCallBack(), and httpd_HostThread().

void httpd_RedirectDelete

(

httpd_redirect_t *

)

References httpd_UrlDelete(), httpd_redirect_t::psz_dst, and httpd_redirect_t::url.

httpd_redirect_t* httpd_RedirectNew	(	httpd_host_t *	,
		const char *	psz_url_dst,
		const char *	psz_url_src
	)

References HTTPD_MSG_DESCRIBE, HTTPD_MSG_GET, HTTPD_MSG_HEAD, HTTPD_MSG_POST, httpd_RedirectCallBack(), httpd_UrlCatch(), httpd_UrlNew(), httpd_redirect_t::psz_dst, strdup(), httpd_redirect_t::url, and xmalloc().

char* httpd_ServerIP	(	const httpd_client_t *	cl,
		char *	,
		int *
	)

References httpd_client_t::fd, and net_GetSockAddress().

void httpd_StreamDelete

(

httpd_stream_t *

)

References httpd_UrlDelete(), httpd_stream_t::lock, httpd_stream_t::p_buffer, httpd_stream_t::p_header, httpd_stream_t::psz_mime, httpd_stream_t::url, and vlc_mutex_destroy().

int httpd_StreamHeader	(	httpd_stream_t *	,
		uint8_t *	p_data,
		int	i_data
	)

< No error

References httpd_stream_t::i_header, httpd_stream_t::lock, httpd_stream_t::p_header, vlc_mutex_lock(), vlc_mutex_unlock(), VLC_SUCCESS, and xmalloc().

httpd_stream_t* httpd_StreamNew	(	httpd_host_t *	,
		const char *	psz_url,
		const char *	psz_mime,
		const char *	psz_user,
		const char *	psz_password
	)

References HTTPD_MSG_GET, HTTPD_MSG_HEAD, HTTPD_MSG_POST, httpd_StreamCallBack(), httpd_UrlCatch(), httpd_UrlNew(), httpd_stream_t::i_buffer_last_pos, httpd_stream_t::i_buffer_pos, httpd_stream_t::i_buffer_size, httpd_stream_t::i_header, httpd_stream_t::lock, httpd_stream_t::p_buffer, httpd_stream_t::p_header, httpd_stream_t::psz_mime, strdup(), httpd_stream_t::url, vlc_mime_Ext2Mime(), vlc_mutex_init(), and xmalloc().

int httpd_StreamSend	(	httpd_stream_t *	,
		uint8_t *	p_data,
		int	i_data
	)

< No error

< No error

References httpd_stream_t::i_buffer_last_pos, httpd_stream_t::i_buffer_pos, httpd_stream_t::i_buffer_size, httpd_stream_t::lock, httpd_stream_t::p_buffer, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

int httpd_UrlCatch	(	httpd_url_t *	,
		int	i_msg,
		httpd_callback_t	,
		httpd_callback_sys_t *
	)

< No error

References httpd_url_t::catch, httpd_url_t::cb, httpd_url_t::lock, httpd_url_t::p_sys, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

Referenced by httpd_FileNew(), httpd_HandlerNew(), httpd_RedirectNew(), and httpd_StreamNew().

void httpd_UrlDelete

(

httpd_url_t *

)

References httpd_host_t::client, httpd_url_t::host, httpd_ClientClean(), httpd_host_t::i_client, httpd_host_t::i_url, httpd_host_t::lock, httpd_url_t::lock, msg_Warn, httpd_url_t::psz_password, httpd_url_t::psz_url, httpd_url_t::psz_user, TAB_REMOVE, httpd_host_t::url, httpd_client_t::url, vlc_mutex_destroy(), vlc_mutex_lock(), and vlc_mutex_unlock().

Referenced by httpd_FileDelete(), httpd_HandlerDelete(), httpd_RedirectDelete(), and httpd_StreamDelete().

httpd_url_t* httpd_UrlNew	(	httpd_host_t *	,
		const char *	psz_url,
		const char *	psz_user,
		const char *	psz_password
	)

References httpd_url_t::catch, httpd_url_t::cb, httpd_url_t::host, HTTPD_MSG_MAX, httpd_host_t::i_url, httpd_host_t::lock, httpd_url_t::lock, msg_Warn, httpd_url_t::p_sys, httpd_url_t::psz_password, httpd_url_t::psz_url, httpd_url_t::psz_user, strdup(), TAB_APPEND, httpd_host_t::url, vlc_cond_signal(), vlc_mutex_init(), vlc_mutex_lock(), vlc_mutex_unlock(), httpd_host_t::wait, and xmalloc().

Referenced by httpd_FileNew(), httpd_HandlerNew(), httpd_RedirectNew(), and httpd_StreamNew().

httpd_host_t* vlc_http_HostNew

(

vlc_object_t *

)

References httpd_HostCreate(), and msg_Err.

httpd_host_t* vlc_https_HostNew

(

vlc_object_t *

)

References httpd_HostCreate(), msg_Err, var_InheritString, vlc_tls_Delete(), vlc_tls_ServerAddCA(), vlc_tls_ServerAddCRL(), and vlc_tls_ServerCreate().

httpd_host_t* vlc_rtsp_HostNew

(

vlc_object_t *

)

References httpd_HostCreate(), and msg_Err.