This are helper provided around core Eio API. More...
Functions | |
EAPI int | eio_init (void) |
Initialize eio and all it's required submodule. | |
EAPI int | eio_shutdown (void) |
Shutdown eio and all it's submodule if possible. | |
EAPI void * | eio_file_container_get (Eio_File *ls) |
Return the container during EIO operation. | |
EAPI Eina_Bool | eio_file_cancel (Eio_File *ls) |
Cancel any Eio_File. | |
EAPI Eina_Bool | eio_file_check (Eio_File *ls) |
Check if an Eio_File operation has been cancelled. | |
EAPI 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. | |
EAPI 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. | |
EAPI 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
EAPI int eio_init | ( | void | ) |
Initialize eio and all it's required submodule.
- Returns
- the current number of eio users.
EAPI int eio_shutdown | ( | void | ) |
Shutdown eio and all it's submodule if possible.
- Returns
- the number of pending users of eio.
EAPI 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.
EAPI 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.
EAPI 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.
EAPI 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 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 don't need to copy the key around you can use eio_file_associate_direct_add
EAPI 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.
EAPI 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.
|
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.
|
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.
|
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
|
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.
|
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.