task_queue.h File Reference

#include <stdint.h>
#include <stddef.h>
#include <boolean.h>
#include <retro_common.h>
#include <retro_common_api.h>

Include dependency graph for task_queue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	decompress_task_data_t
struct	retro_task
struct	task_finder_data
struct	task_retriever_info
struct	task_retriever_data

Typedefs
typedef struct retro_task	retro_task_t
typedef void(*	retro_task_callback_t) (void *task_data, void *user_data, const char *error)
typedef void(*	retro_task_handler_t) (retro_task_t *task)
typedef bool(*	retro_task_finder_t) (retro_task_t *task, void *userdata)
typedef void(*	retro_task_queue_msg_t) (const char *msg, unsigned prio, unsigned duration, bool flush)
typedef bool(*	retro_task_retriever_t) (retro_task_t *task, void *data)
typedef bool(*	retro_task_condition_fn_t) (void *data)
typedef struct task_finder_data	task_finder_data_t
typedef struct task_retriever_info	task_retriever_info_t
typedef struct task_retriever_data	task_retriever_data_t

Enumerations
enum	task_type { TASK_TYPE_NONE, TASK_TYPE_BLOCKING }

Functions
void *	task_queue_retriever_info_next (task_retriever_info_t **link)
void	task_queue_retriever_info_free (task_retriever_info_t *list)
void	task_queue_cancel_task (void *task)
void	task_set_finished (retro_task_t *task, bool finished)
void	task_set_mute (retro_task_t *task, bool mute)
void	task_set_error (retro_task_t *task, char *error)
void	task_set_progress (retro_task_t *task, int8_t progress)
void	task_set_title (retro_task_t *task, char *title)
void	task_set_data (retro_task_t *task, void *data)
void	task_set_cancelled (retro_task_t *task, bool cancelled)
void	task_free_title (retro_task_t *task)
bool	task_get_cancelled (retro_task_t *task)
bool	task_get_finished (retro_task_t *task)
bool	task_get_mute (retro_task_t *task)
char *	task_get_error (retro_task_t *task)
int8_t	task_get_progress (retro_task_t *task)
char *	task_get_title (retro_task_t *task)
void *	task_get_data (retro_task_t *task)
void	task_queue_set_threaded (void)
void	task_queue_unset_threaded (void)
bool	task_queue_is_threaded (void)
bool	task_queue_find (task_finder_data_t *find_data)
void	task_queue_retrieve (task_retriever_data_t *data)
void	task_queue_check (void)
void	task_queue_push (retro_task_t *task)
void	task_queue_wait (retro_task_condition_fn_t cond, void *data)
void	task_queue_reset (void)
void	task_queue_deinit (void)
void	task_queue_init (bool threaded, retro_task_queue_msg_t msg_push)

Typedef Documentation

retro_task_callback_t

typedef void(* retro_task_callback_t) (void *task_data, void *user_data, const char *error)

retro_task_condition_fn_t

typedef bool(* retro_task_condition_fn_t) (void *data)

retro_task_finder_t

typedef bool(* retro_task_finder_t) (retro_task_t *task, void *userdata)

retro_task_handler_t

typedef void(* retro_task_handler_t) (retro_task_t *task)

retro_task_queue_msg_t

typedef void(* retro_task_queue_msg_t) (const char *msg, unsigned prio, unsigned duration, bool flush)

retro_task_retriever_t

typedef bool(* retro_task_retriever_t) (retro_task_t *task, void *data)

retro_task_t

typedef struct retro_task retro_task_t

task_finder_data_t

typedef struct task_finder_data task_finder_data_t

task_retriever_data_t

typedef struct task_retriever_data task_retriever_data_t

task_retriever_info_t

typedef struct task_retriever_info task_retriever_info_t

Enumeration Type Documentation

task_type

enum task_type

Enumerator
TASK_TYPE_NONE
TASK_TYPE_BLOCKING

Function Documentation

task_free_title()

void task_free_title

(

retro_task_t *

task

)

Here is the call graph for this function:

Here is the caller graph for this function:

task_get_cancelled()

bool task_get_cancelled

(

retro_task_t *

task

)

Here is the caller graph for this function:

task_get_data()

void* task_get_data

(

retro_task_t *

task

)

task_get_error()

char* task_get_error

(

retro_task_t *

task

)

Here is the call graph for this function:

Here is the caller graph for this function:

task_get_finished()

bool task_get_finished

(

retro_task_t *

task

)

Here is the caller graph for this function:

task_get_mute()

bool task_get_mute

(

retro_task_t *

task

)

Here is the caller graph for this function:

task_get_progress()

int8_t task_get_progress

(

retro_task_t *

task

)

Here is the caller graph for this function:

task_get_title()

char* task_get_title

(

retro_task_t *

task

)

task_queue_cancel_task()

void task_queue_cancel_task

(

void *

task

)

Signals a task to end without waiting for it to complete.

Here is the caller graph for this function:

task_queue_check()

void task_queue_check

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

task_queue_deinit()

void task_queue_deinit

(

void

)

Here is the caller graph for this function:

task_queue_find()

bool task_queue_find

(

task_finder_data_t *

find_data

)

Calls func for every running task until it returns true. Returns a task or NULL if not found.

Here is the caller graph for this function:

task_queue_init()

void task_queue_init	(	bool	threaded,
		retro_task_queue_msg_t	msg_push
	)

Here is the caller graph for this function:

task_queue_is_threaded()

bool task_queue_is_threaded

(

void

)

Here is the caller graph for this function:

task_queue_push()

void task_queue_push

(

retro_task_t *

task

)

Here is the caller graph for this function:

task_queue_reset()

void task_queue_reset

(

void

)

task_queue_retrieve()

void task_queue_retrieve

(

task_retriever_data_t *

data

)

Calls func for every running task when handler parameter matches task handler, allowing the list parameter to be filled with user-defined data.

Here is the caller graph for this function:

task_queue_retriever_info_free()

void task_queue_retriever_info_free

(

task_retriever_info_t *

list

)

Here is the call graph for this function:

task_queue_retriever_info_next()

void* task_queue_retriever_info_next

(

task_retriever_info_t **

link

)

Here is the call graph for this function:

task_queue_set_threaded()

void task_queue_set_threaded

(

void

)

Here is the caller graph for this function:

task_queue_unset_threaded()

void task_queue_unset_threaded

(

void

)

Here is the caller graph for this function:

task_queue_wait()

void task_queue_wait	(	retro_task_condition_fn_t	cond,
		void *	data
	)

Here is the call graph for this function:

Here is the caller graph for this function:

task_set_cancelled()

void task_set_cancelled	(	retro_task_t *	task,
		bool	cancelled
	)

Here is the caller graph for this function:

task_set_data()

void task_set_data	(	retro_task_t *	task,
		void *	data
	)

Here is the caller graph for this function:

task_set_error()

void task_set_error	(	retro_task_t *	task,
		char *	error
	)

Here is the call graph for this function:

Here is the caller graph for this function:

task_set_finished()

void task_set_finished	(	retro_task_t *	task,
		bool	finished
	)

Here is the caller graph for this function:

task_set_mute()

void task_set_mute	(	retro_task_t *	task,
		bool	mute
	)

task_set_progress()

void task_set_progress	(	retro_task_t *	task,
		int8_t	progress
	)

Here is the caller graph for this function:

task_set_title()

void task_set_title	(	retro_task_t *	task,
		char *	title
	)

Here is the caller graph for this function: