Eio Reference helper API

This are helper provided around core Eio API. More...

Functions
int	eio_init (void)
	Initialize eio and all it's required submodule.
int	eio_shutdown (void)
	Shutdown eio and all it's submodule if possible.
void *	eio_file_container_get (Eio_File *ls)
	Return the container during EIO operation.
Eina_Bool	eio_file_cancel (Eio_File *ls)
	Cancel any Eio_File.
Eina_Bool	eio_file_check (Eio_File *ls)
	Check if an Eio_File operation has been cancelled.
Eina_Bool	eio_file_associate_add (Eio_File *ls, const char *key, const void *data, Eina_Free_Cb free_cb)
	Associate data with the current filtered file.
Eina_Bool	eio_file_associate_direct_add (Eio_File *ls, const char *key, const void *data, Eina_Free_Cb free_cb)
	Associate data with the current filtered file.
void *	eio_file_associate_find (Eio_File *ls, const char *key)
	Get the data associated during the filter callback inside the main loop.
static double	eio_file_atime (const Eina_Stat *stat)
	get access time from a Eina_Stat
static double	eio_file_mtime (const Eina_Stat *stat)
	get modification time from a Eina_Stat
static long long	eio_file_size (const Eina_Stat *stat)
	get the size of the file described in Eina_Stat
static Eina_Bool	eio_file_is_dir (const Eina_Stat *stat)
	tell if the stated path was a directory or not.
static Eina_Bool	eio_file_is_lnk (const Eina_Stat *stat)
	tell if the stated path was a link or not.

Detailed Description

This are helper provided around core Eio API.

This set of functions do provide helper to work around data provided by Eio without the need to look at system header.

Function Documentation

int eio_init

(

void

)

Initialize eio and all it's required submodule.

Returns

the current number of eio users.

References ecore_init(), eina_init(), eina_log_domain_register(), eina_log_domain_unregister(), EINA_LOG_ERR, and eina_shutdown().

int eio_shutdown

(

void

)

Shutdown eio and all it's submodule if possible.

Returns

the number of pending users of eio.

References ecore_shutdown(), eina_log_domain_unregister(), eina_shutdown(), and EINA_TRASH_CLEAN.

void* eio_file_container_get

(

Eio_File *

ls

)

Return the container during EIO operation.

Parameters

ls	The asynchronous I/O operation to retrieve container from.

Returns

NULL if not available, a DIRP if it is.

This is only available and make sense in the thread callback, not in the mainloop.

References EINA_FALSE, and EINA_SAFETY_ON_NULL_RETURN_VAL.

Eina_Bool eio_file_cancel

(

Eio_File *

ls

)

Cancel any Eio_File.

Parameters

ls	The asynchronous I/O operation to cancel.

Returns

EINA_FALSE if the destruction is delayed, EINA_TRUE if it's done.

This will cancel any kind of I/O operation and cleanup the mess. This means that it could take time to cancel an I/O.

References ecore_thread_cancel(), EINA_FALSE, and EINA_SAFETY_ON_NULL_RETURN_VAL.

Eina_Bool eio_file_check

(

Eio_File *

ls

)

Check if an Eio_File operation has been cancelled.

Parameters

ls	The asynchronous I/O operation to check.

Returns

EINA_TRUE if it was canceled, EINA_FALSE other wise.

In case of an error it also return EINA_TRUE.

References ecore_thread_check(), EINA_SAFETY_ON_NULL_RETURN_VAL, and EINA_TRUE.

Eina_Bool eio_file_associate_add	(	Eio_File *	ls,
		const char *	key,
		const void *	data,
		Eina_Free_Cb	free_cb
	)

Associate data with the current filtered file.

Parameters

ls	The Eio_File ls request currently calling the filter callback.
key	The key to associate data to.
data	The data to associate the data to.
free_cb	Optionally a function to call to free the associated data, data is passed as the callback data parameter. If no is provided the user data remains untouched.

Returns

EINA_TRUE if insertion was fine.

This function can only be safely called from within the filter callback. If you don't need to copy the key around you can use eio_file_associate_direct_add

References eina_hash_add(), and eina_hash_string_small_new().

Eina_Bool eio_file_associate_direct_add	(	Eio_File *	ls,
		const char *	key,
		const void *	data,
		Eina_Free_Cb	free_cb
	)

Associate data with the current filtered file.

Parameters

ls	The Eio_File ls request currently calling the filter callback.
key	The key to associate data to (will not be copied, and the pointer will not be used as long as the file is not notified).
data	The data to associate the data to.
free_cb	The function to call to free the associated data, free will be called if not specified.

Returns

EINA_TRUE if insertion was fine.

This function can only be safely called from within the filter callback. If you need eio to make a proper copy of the key to be safe use eio_file_associate_add instead.

References eina_hash_direct_add(), and eina_hash_string_small_new().

void* eio_file_associate_find	(	Eio_File *	ls,
		const char *	key
	)

Get the data associated during the filter callback inside the main loop.

Parameters

ls	The Eio_File ls request currently calling the notify callback.
key	The key pointing to the data to retrieve.

Returns

the data associated with the key or NULL if not found.

References eina_hash_find().

static double eio_file_atime ( const Eina_Stat *  stat )

inlinestatic

get access time from a Eina_Stat

Parameters

stat	the structure to get the atime from

Returns

the last accessed time

This take care of doing type conversion to match rest of EFL time API.

Note

some filesystem don't update that information.

static double eio_file_mtime ( const Eina_Stat *  stat )

inlinestatic

get modification time from a Eina_Stat

Parameters

stat	the structure to get the mtime from

Returns

the last modification time

This take care of doing type conversion to match rest of EFL time API.

static long long eio_file_size ( const Eina_Stat *  stat )

inlinestatic

get the size of the file described in Eina_Stat

Parameters

stat	the structure to get the size from

Returns

the size of the file

static Eina_Bool eio_file_is_dir ( const Eina_Stat *  stat )

inlinestatic

tell if the stated path was a directory or not.

Parameters

stat	the structure to get the size from

Returns

EINA_TRUE, if it was.

static Eina_Bool eio_file_is_lnk ( const Eina_Stat *  stat )

inlinestatic

tell if the stated path was a link or not.

Parameters

stat	the structure to get the size from

Returns

EINA_TRUE, if it was.