fetcher.h File Reference

Include dependency graph for fetcher.h:

Go to the source code of this file.

Data Structures
struct	input_fetcher_callbacks_t

Typedefs
typedef struct input_fetcher_t	input_fetcher_t
	Fetcher opaque structure.
typedef struct input_fetcher_callbacks_t	input_fetcher_callbacks_t

Functions
input_fetcher_t *	input_fetcher_New (vlc_object_t *, int request_type)
	This function creates the fetcher object and thread.
int	input_fetcher_Push (input_fetcher_t *, input_item_t *, int, const input_fetcher_callbacks_t *, void *)
	This function enqueues the provided item to be art fetched.
void	input_fetcher_Delete (input_fetcher_t *)
	This function destroys the fetcher object and thread.

Typedef Documentation

input_fetcher_callbacks_t

typedef struct input_fetcher_callbacks_t input_fetcher_callbacks_t

input_fetcher_t

typedef struct input_fetcher_t input_fetcher_t

Fetcher opaque structure.

The fetcher object will retrieve the art album data for any given input item in an asynchronous way.

Function Documentation

input_fetcher_Delete()

void input_fetcher_Delete

(

input_fetcher_t *

fetcher

)

This function destroys the fetcher object and thread.

All pending input items will be released.

References input_fetcher_t::album_cache, CancelAllTasks(), input_fetcher_t::executor_downloader, input_fetcher_t::executor_local, input_fetcher_t::executor_network, task::fetcher, FreeCacheEntry(), vlc_dictionary_clear(), and vlc_executor_Delete().

Referenced by vlc_preparser_Delete(), and vlc_preparser_New().

input_fetcher_New()

input_fetcher_t * input_fetcher_New	(	vlc_object_t *	owner,
		int	request_type
	)

This function creates the fetcher object and thread.

Parameters

request_type

a combination of VLC_PREPARSER_TYPE_FETCHMETA_LOCAL and VLC_PREPARSER_TYPE_FETCHMETA_NET, it is used to setup the executors for each domain.

References input_fetcher_t::album_cache, input_fetcher_t::executor_downloader, input_fetcher_t::executor_local, input_fetcher_t::executor_network, task::fetcher, input_fetcher_t::lock, input_fetcher_t::owner, input_fetcher_t::submitted_tasks, unlikely, var_InheritInteger(), vlc_dictionary_init(), vlc_executor_Delete(), vlc_executor_New(), vlc_list_init(), vlc_mutex_init(), VLC_PREPARSER_TYPE_FETCHMETA_ALL, VLC_PREPARSER_TYPE_FETCHMETA_LOCAL, and VLC_PREPARSER_TYPE_FETCHMETA_NET.

Referenced by vlc_preparser_New().

input_fetcher_Push()

int input_fetcher_Push	(	input_fetcher_t *	fetcher,
		input_item_t *	item,
		int	options,
		const input_fetcher_callbacks_t *	cbs,
		void *	cbs_userdata
	)

This function enqueues the provided item to be art fetched.

The input item is retained until the art fetching is done or until the fetcher object is destroyed.

References task::cbs, task::executor, input_fetcher_t::executor_local, input_fetcher_t::executor_network, task::fetcher, task::item, task::options, Submit(), VLC_PREPARSER_TYPE_FETCHMETA_ALL, VLC_PREPARSER_TYPE_FETCHMETA_LOCAL, and VLC_PREPARSER_TYPE_FETCHMETA_NET.

Referenced by Fetch().