\hypertarget{group__Eio__Helper}{}\doxysection{Eio Reference helper API}
\label{group__Eio__Helper}\index{Eio Reference helper API@{Eio Reference helper API}}


This are helper provided around core Eio API.  


\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
static double \mbox{\hyperlink{group__Eio__Helper_ga1bfe4349ddbeee3ed66e258854fdda70}{eio\+\_\+file\+\_\+atime}} (const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$st)
\begin{DoxyCompactList}\small\item\em Return last access time to a file. \end{DoxyCompactList}\item 
static double \mbox{\hyperlink{group__Eio__Helper_gab0961eca21bfc163442ca0cd3f139923}{eio\+\_\+file\+\_\+mtime}} (const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$st)
\begin{DoxyCompactList}\small\item\em Return last modification time of a file. \end{DoxyCompactList}\item 
static long long \mbox{\hyperlink{group__Eio__Helper_ga16df03866c1f8b1f87809eaccca92dc9}{eio\+\_\+file\+\_\+size}} (const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$st)
\begin{DoxyCompactList}\small\item\em Return file length. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Eio__Helper_ga21ecd1e03f206b11a93f30cd454c344b}{eio\+\_\+file\+\_\+is\+\_\+dir}} (const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$st)
\begin{DoxyCompactList}\small\item\em Return if path is a directory. \end{DoxyCompactList}\item 
static \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Eio__Helper_ga90e46490c74e0bf8dacf9faa2cceee44}{eio\+\_\+file\+\_\+is\+\_\+lnk}} (const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$st)
\begin{DoxyCompactList}\small\item\em Return if path is a length. \end{DoxyCompactList}\item 
EIO\+\_\+\+API int \mbox{\hyperlink{group__Eio__Helper_ga557c198fc1a90518d7872b77843fa029}{eio\+\_\+init}} (void)
\begin{DoxyCompactList}\small\item\em Initialize eio and all its required submodule. \end{DoxyCompactList}\item 
EIO\+\_\+\+API int \mbox{\hyperlink{group__Eio__Helper_ga7c3ad77c3f9a0346aab50f474af54b6c}{eio\+\_\+shutdown}} (void)
\begin{DoxyCompactList}\small\item\em Shutdown eio and all its submodule if possible. \end{DoxyCompactList}\item 
EIO\+\_\+\+API void \mbox{\hyperlink{group__Eio__Helper_gae90b12b2c8fc4d9a773784bc63d168d4}{eio\+\_\+memory\+\_\+burst\+\_\+limit\+\_\+set}} (size\+\_\+t limit)
\begin{DoxyCompactList}\small\item\em Set the limit to the maximum amount of memory used. \end{DoxyCompactList}\item 
EIO\+\_\+\+API size\+\_\+t \mbox{\hyperlink{group__Eio__Helper_gaa36a5206a9a7baa3c4f85ff23d99cba3}{eio\+\_\+memory\+\_\+burst\+\_\+limit\+\_\+get}} (void)
\begin{DoxyCompactList}\small\item\em Get the actual limit to the maximum amount of memory used. \end{DoxyCompactList}\item 
EIO\+\_\+\+API void $\ast$ \mbox{\hyperlink{group__Eio__Helper_gae8d2adf15a58ba45917c2ef2e8b9a76b}{eio\+\_\+file\+\_\+container\+\_\+get}} (\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$ls)
\begin{DoxyCompactList}\small\item\em Return the container during EIO operation. \end{DoxyCompactList}\item 
EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Eio__Helper_ga91439a6bb5b13ee3162f7fa8644d1b17}{eio\+\_\+file\+\_\+cancel}} (\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$ls)
\begin{DoxyCompactList}\small\item\em Cancel any Eio\+\_\+\+File. \end{DoxyCompactList}\item 
EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Eio__Helper_ga4d6d16c11f262df789dbbb1f94130fd4}{eio\+\_\+file\+\_\+check}} (\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$ls)
\begin{DoxyCompactList}\small\item\em Check if an Eio\+\_\+\+File operation has been cancelled. \end{DoxyCompactList}\item 
EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Eio__Helper_ga5adda9eb0d7ea6a2cfb4cbc704f168b6}{eio\+\_\+file\+\_\+associate\+\_\+add}} (\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$ls, const char $\ast$key, const void $\ast$data, \mbox{\hyperlink{group__Eina__Types__Group_gadbac560ba2bca5c61d97bfbb542018f3}{Eina\+\_\+\+Free\+\_\+\+Cb}} free\+\_\+cb)
\begin{DoxyCompactList}\small\item\em Associate data with the current filtered file. \end{DoxyCompactList}\item 
EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Eio__Helper_ga21ba16681ee628f55693e5222713ef73}{eio\+\_\+file\+\_\+associate\+\_\+direct\+\_\+add}} (\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$ls, const char $\ast$key, const void $\ast$data, \mbox{\hyperlink{group__Eina__Types__Group_gadbac560ba2bca5c61d97bfbb542018f3}{Eina\+\_\+\+Free\+\_\+\+Cb}} free\+\_\+cb)
\begin{DoxyCompactList}\small\item\em Associate data with the current filtered file. \end{DoxyCompactList}\item 
EIO\+\_\+\+API void $\ast$ \mbox{\hyperlink{group__Eio__Helper_gac6522fcb1bb47013644513b25bba6f16}{eio\+\_\+file\+\_\+associate\+\_\+find}} (\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$ls, const char $\ast$key)
\begin{DoxyCompactList}\small\item\em Get the data associated during the filter callback inside the main loop. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{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. 

\doxysubsection{Function Documentation}
\mbox{\Hypertarget{group__Eio__Helper_ga1bfe4349ddbeee3ed66e258854fdda70}\label{group__Eio__Helper_ga1bfe4349ddbeee3ed66e258854fdda70}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_atime@{eio\_file\_atime}}
\index{eio\_file\_atime@{eio\_file\_atime}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_atime()}{eio\_file\_atime()}}
{\footnotesize\ttfamily static double eio\+\_\+file\+\_\+atime (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$}]{st }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Return last access time to a file. 


\begin{DoxyParams}{Parameters}
{\em st} & The stat buffer as given by eio\+\_\+file\+\_\+stat callback. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
last access time.
\end{DoxyReturn}
This function return the st\+\_\+atime field, last access time, as double like all EFL time call. 

References \mbox{\hyperlink{struct__Eina__Stat_ada067299e3d8f39599241da8a55852f3}{\+\_\+\+Eina\+\_\+\+Stat\+::atime}}.

\mbox{\Hypertarget{group__Eio__Helper_gab0961eca21bfc163442ca0cd3f139923}\label{group__Eio__Helper_gab0961eca21bfc163442ca0cd3f139923}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_mtime@{eio\_file\_mtime}}
\index{eio\_file\_mtime@{eio\_file\_mtime}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_mtime()}{eio\_file\_mtime()}}
{\footnotesize\ttfamily static double eio\+\_\+file\+\_\+mtime (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$}]{st }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Return last modification time of a file. 


\begin{DoxyParams}{Parameters}
{\em st} & The stat buffer as given by eio\+\_\+file\+\_\+stat callback. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
last modification time.
\end{DoxyReturn}
This function return the st\+\_\+mtime field, last modification time, as double like all EFL time call. 

References \mbox{\hyperlink{struct__Eina__Stat_ab7831e00d54804a0105fac9f7b881b24}{\+\_\+\+Eina\+\_\+\+Stat\+::mtime}}.

\mbox{\Hypertarget{group__Eio__Helper_ga16df03866c1f8b1f87809eaccca92dc9}\label{group__Eio__Helper_ga16df03866c1f8b1f87809eaccca92dc9}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_size@{eio\_file\_size}}
\index{eio\_file\_size@{eio\_file\_size}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_size()}{eio\_file\_size()}}
{\footnotesize\ttfamily static long long eio\+\_\+file\+\_\+size (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$}]{st }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Return file length. 


\begin{DoxyParams}{Parameters}
{\em st} & The stat buffer as given by eio\+\_\+file\+\_\+stat callback. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the length of a file.
\end{DoxyReturn}
This function is just an accessor to st\+\_\+size and return the file length. 

References \mbox{\hyperlink{struct__Eina__Stat_af7c6c5533f01b5db152598345f0ad671}{\+\_\+\+Eina\+\_\+\+Stat\+::size}}.

\mbox{\Hypertarget{group__Eio__Helper_ga21ecd1e03f206b11a93f30cd454c344b}\label{group__Eio__Helper_ga21ecd1e03f206b11a93f30cd454c344b}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_is\_dir@{eio\_file\_is\_dir}}
\index{eio\_file\_is\_dir@{eio\_file\_is\_dir}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_is\_dir()}{eio\_file\_is\_dir()}}
{\footnotesize\ttfamily static \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} eio\+\_\+file\+\_\+is\+\_\+dir (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$}]{st }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Return if path is a directory. 


\begin{DoxyParams}{Parameters}
{\em st} & The stat buffer as given by eio\+\_\+file\+\_\+stat callback. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
EINA\+\_\+\+TRUE if the path is a directory.
\end{DoxyReturn}
This function tell you if the stated path is a directory or not. 

References \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}, \mbox{\hyperlink{group__Eina__Types__Group_ga05c12dacc8b4058994df842b41be85fc}{EINA\+\_\+\+TRUE}}, and \mbox{\hyperlink{struct__Eina__Stat_a9592a3a7e4ce82ba95ce094cba4b6ba6}{\+\_\+\+Eina\+\_\+\+Stat\+::mode}}.

\mbox{\Hypertarget{group__Eio__Helper_ga90e46490c74e0bf8dacf9faa2cceee44}\label{group__Eio__Helper_ga90e46490c74e0bf8dacf9faa2cceee44}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_is\_lnk@{eio\_file\_is\_lnk}}
\index{eio\_file\_is\_lnk@{eio\_file\_is\_lnk}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_is\_lnk()}{eio\_file\_is\_lnk()}}
{\footnotesize\ttfamily static \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} eio\+\_\+file\+\_\+is\+\_\+lnk (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Eina__File__Group_gab15fe1278f044850fcb24417a47364a8}{Eina\+\_\+\+Stat}} $\ast$}]{st }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}



Return if path is a length. 


\begin{DoxyParams}{Parameters}
{\em st} & The stat buffer as given by eio\+\_\+file\+\_\+stat callback. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
EINA\+\_\+\+TRUE if the path is a length.
\end{DoxyReturn}
This function tell you if the stated path is a length or not.

\begin{DoxyNote}{Note}
On Windows, this function returns always \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}. 
\end{DoxyNote}


References \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}, \mbox{\hyperlink{group__Eina__Types__Group_ga05c12dacc8b4058994df842b41be85fc}{EINA\+\_\+\+TRUE}}, and \mbox{\hyperlink{struct__Eina__Stat_a9592a3a7e4ce82ba95ce094cba4b6ba6}{\+\_\+\+Eina\+\_\+\+Stat\+::mode}}.

\mbox{\Hypertarget{group__Eio__Helper_ga557c198fc1a90518d7872b77843fa029}\label{group__Eio__Helper_ga557c198fc1a90518d7872b77843fa029}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_init@{eio\_init}}
\index{eio\_init@{eio\_init}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_init()}{eio\_init()}}
{\footnotesize\ttfamily EIO\+\_\+\+API int eio\+\_\+init (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Initialize eio and all its required submodule. 

\begin{DoxyReturn}{Returns}
the current number of eio users. 
\end{DoxyReturn}
\begin{Desc}
\item[Examples]\par
\mbox{\hyperlink{eio_file_ls_8c-example}{eio\+\_\+file\+\_\+ls.\+c}}.\end{Desc}


References \mbox{\hyperlink{group__Ecore__Init__Group_ga77757609684a2c922dc5ec398274751b}{ecore\+\_\+init()}}, \mbox{\hyperlink{group__Efreet__Mime_gad63027f25e77f7c2298f01f2b705465a}{efreet\+\_\+mime\+\_\+init()}}, \mbox{\hyperlink{group__Eina__Main__Group_ga81b8137665b8a4d2cb38ca50017d4c74}{eina\+\_\+init()}}, \mbox{\hyperlink{group__Eina__Log__Group_ga79d0a42ab10dd0e7760b33ae33a6aae0}{eina\+\_\+log\+\_\+domain\+\_\+register()}}, \mbox{\hyperlink{group__Eina__Log__Group_ga61776fa99e910e2d40f77c688c9bee5a}{eina\+\_\+log\+\_\+domain\+\_\+unregister()}}, \mbox{\hyperlink{group__Eina__Log__Group_ga2e33caeeeb6051526c01b7fea4d6c91b}{EINA\+\_\+\+LOG\+\_\+\+ERR}}, \mbox{\hyperlink{group__Eina__Log__Group_ga079e9de9602815a6de0d5188b65c07a2}{EINA\+\_\+\+LOG\+\_\+\+STATE\+\_\+\+INIT}}, \mbox{\hyperlink{group__Eina__Log__Group_gga125f3b55502884020a1546d0575ae052adcc235504e74cbd641635c0af36e9d47}{EINA\+\_\+\+LOG\+\_\+\+STATE\+\_\+\+STOP}}, \mbox{\hyperlink{group__Eina__Log__Group_gaceb7074e48242643ec8d3d664a32801e}{eina\+\_\+log\+\_\+timing()}}, and \mbox{\hyperlink{group__Eina__Main__Group_ga5bf35513199d5220341437c05696285d}{eina\+\_\+shutdown()}}.



Referenced by \mbox{\hyperlink{group__Elm__General_gab31fb3af2f25295fea1eb05f69724eb5}{elm\+\_\+quicklaunch\+\_\+init()}}.

\mbox{\Hypertarget{group__Eio__Helper_ga7c3ad77c3f9a0346aab50f474af54b6c}\label{group__Eio__Helper_ga7c3ad77c3f9a0346aab50f474af54b6c}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_shutdown@{eio\_shutdown}}
\index{eio\_shutdown@{eio\_shutdown}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_shutdown()}{eio\_shutdown()}}
{\footnotesize\ttfamily EIO\+\_\+\+API int eio\+\_\+shutdown (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Shutdown eio and all its submodule if possible. 

\begin{DoxyReturn}{Returns}
the number of pending users of eio. 
\end{DoxyReturn}
\begin{Desc}
\item[Examples]\par
\mbox{\hyperlink{eio_file_ls_8c-example}{eio\+\_\+file\+\_\+ls.\+c}}.\end{Desc}


References \mbox{\hyperlink{group__Ecore__Init__Group_ga768298b932f18d7e7593a447493e5cde}{ecore\+\_\+shutdown()}}, \mbox{\hyperlink{group__Ecore__Thread__Group_gae9b9b20e1ed53c62c51617b55aed2511}{ecore\+\_\+thread\+\_\+cancel()}}, \mbox{\hyperlink{group__Ecore__Thread__Group_ga0b252a091ed78a33afed31cf147f58e2}{ecore\+\_\+thread\+\_\+wait()}}, \mbox{\hyperlink{group__Efreet__Mime_gacda6031934032e4b4610f0062a537274}{efreet\+\_\+mime\+\_\+shutdown()}}, \mbox{\hyperlink{group__Eina__List__Group_gac6efafc19f526d916cdb9757240a8773}{EINA\+\_\+\+LIST\+\_\+\+FOREACH}}, \mbox{\hyperlink{group__Eina__List__Group_gae27a2c686a0a11693f9b06957c9bba83}{EINA\+\_\+\+LIST\+\_\+\+FREE}}, \mbox{\hyperlink{group__Eina__Log__Group_ga61776fa99e910e2d40f77c688c9bee5a}{eina\+\_\+log\+\_\+domain\+\_\+unregister()}}, \mbox{\hyperlink{group__Eina__Log__Group_ga527ad9352599d503a53bf834868d3461}{EINA\+\_\+\+LOG\+\_\+\+STATE\+\_\+\+SHUTDOWN}}, \mbox{\hyperlink{group__Eina__Log__Group_gga125f3b55502884020a1546d0575ae052a42e956e3a69ea29632f7e9d27a269903}{EINA\+\_\+\+LOG\+\_\+\+STATE\+\_\+\+START}}, \mbox{\hyperlink{group__Eina__Log__Group_gaceb7074e48242643ec8d3d664a32801e}{eina\+\_\+log\+\_\+timing()}}, \mbox{\hyperlink{group__Eina__Main__Group_ga5bf35513199d5220341437c05696285d}{eina\+\_\+shutdown()}}, and \mbox{\hyperlink{group__Eina__Trash__Group_ga00b441d87ac8e3417b0026309024c7c0}{EINA\+\_\+\+TRASH\+\_\+\+CLEAN}}.



Referenced by \mbox{\hyperlink{group__Elm__General_gab31fb3af2f25295fea1eb05f69724eb5}{elm\+\_\+quicklaunch\+\_\+init()}}, and \mbox{\hyperlink{group__Elm__General_ga9fcc62ef962c1b166c693cfd6f2372e4}{elm\+\_\+quicklaunch\+\_\+shutdown()}}.

\mbox{\Hypertarget{group__Eio__Helper_gae90b12b2c8fc4d9a773784bc63d168d4}\label{group__Eio__Helper_gae90b12b2c8fc4d9a773784bc63d168d4}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_memory\_burst\_limit\_set@{eio\_memory\_burst\_limit\_set}}
\index{eio\_memory\_burst\_limit\_set@{eio\_memory\_burst\_limit\_set}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_memory\_burst\_limit\_set()}{eio\_memory\_burst\_limit\_set()}}
{\footnotesize\ttfamily EIO\+\_\+\+API void eio\+\_\+memory\+\_\+burst\+\_\+limit\+\_\+set (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{limit }\end{DoxyParamCaption})}



Set the limit to the maximum amount of memory used. 


\begin{DoxyParams}{Parameters}
{\em limit} & The actual limit to set.\\
\hline
\end{DoxyParams}
Eio work by burst, allocating memory in a thread and moving it back to the main loop. This result in quite some huge memory usage if the main loop is to slow to cope with the speed of the thread. By setting this limit, the thread will block until enough memory has been freed to be below the limit again.

By default no limit is set and any value \texorpdfstring{$<$}{<} 0 will mean no limit.

\begin{DoxyNote}{Note}
You should give at least a reasonable amount of memory or the thread might stall. 
\end{DoxyNote}
\begin{DoxySince}{Since}
1.\+10 
\end{DoxySince}
\mbox{\Hypertarget{group__Eio__Helper_gaa36a5206a9a7baa3c4f85ff23d99cba3}\label{group__Eio__Helper_gaa36a5206a9a7baa3c4f85ff23d99cba3}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_memory\_burst\_limit\_get@{eio\_memory\_burst\_limit\_get}}
\index{eio\_memory\_burst\_limit\_get@{eio\_memory\_burst\_limit\_get}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_memory\_burst\_limit\_get()}{eio\_memory\_burst\_limit\_get()}}
{\footnotesize\ttfamily EIO\+\_\+\+API size\+\_\+t eio\+\_\+memory\+\_\+burst\+\_\+limit\+\_\+get (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Get the actual limit to the maximum amount of memory used. 

\begin{DoxyReturn}{Returns}
The current limit being set.
\end{DoxyReturn}
\begin{DoxySince}{Since}
1.\+10 
\end{DoxySince}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__Eio__Helper_gae90b12b2c8fc4d9a773784bc63d168d4}{eio\+\_\+memory\+\_\+burst\+\_\+limit\+\_\+set}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{group__Eio__Helper_gae8d2adf15a58ba45917c2ef2e8b9a76b}\label{group__Eio__Helper_gae8d2adf15a58ba45917c2ef2e8b9a76b}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_container\_get@{eio\_file\_container\_get}}
\index{eio\_file\_container\_get@{eio\_file\_container\_get}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_container\_get()}{eio\_file\_container\_get()}}
{\footnotesize\ttfamily EIO\+\_\+\+API void $\ast$ eio\+\_\+file\+\_\+container\+\_\+get (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$}]{ls }\end{DoxyParamCaption})}



Return the container during EIO operation. 


\begin{DoxyParams}{Parameters}
{\em ls} & The asynchronous I/O operation to retrieve container from. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
NULL if not available, a DIRP if it is.
\end{DoxyReturn}
This is only available and make sense in the thread callback, not in the mainloop. 

References \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}.

\mbox{\Hypertarget{group__Eio__Helper_ga91439a6bb5b13ee3162f7fa8644d1b17}\label{group__Eio__Helper_ga91439a6bb5b13ee3162f7fa8644d1b17}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_cancel@{eio\_file\_cancel}}
\index{eio\_file\_cancel@{eio\_file\_cancel}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_cancel()}{eio\_file\_cancel()}}
{\footnotesize\ttfamily EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} eio\+\_\+file\+\_\+cancel (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$}]{ls }\end{DoxyParamCaption})}



Cancel any Eio\+\_\+\+File. 


\begin{DoxyParams}{Parameters}
{\em ls} & The asynchronous I/O operation to cancel. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
EINA\+\_\+\+FALSE if the destruction is delayed, EINA\+\_\+\+TRUE if it\textquotesingle{}s done.
\end{DoxyReturn}
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 \mbox{\hyperlink{group__Ecore__Thread__Group_gae9b9b20e1ed53c62c51617b55aed2511}{ecore\+\_\+thread\+\_\+cancel()}}, \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}, and \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}.

\mbox{\Hypertarget{group__Eio__Helper_ga4d6d16c11f262df789dbbb1f94130fd4}\label{group__Eio__Helper_ga4d6d16c11f262df789dbbb1f94130fd4}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_check@{eio\_file\_check}}
\index{eio\_file\_check@{eio\_file\_check}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_check()}{eio\_file\_check()}}
{\footnotesize\ttfamily EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} eio\+\_\+file\+\_\+check (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$}]{ls }\end{DoxyParamCaption})}



Check if an Eio\+\_\+\+File operation has been cancelled. 


\begin{DoxyParams}{Parameters}
{\em ls} & The asynchronous I/O operation to check. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
EINA\+\_\+\+TRUE if it was canceled, EINA\+\_\+\+FALSE other wise.
\end{DoxyReturn}
In case of an error it also return EINA\+\_\+\+TRUE. 

References \mbox{\hyperlink{group__Ecore__Thread__Group_ga792471a7ed00718b71d58b791ddbd08d}{ecore\+\_\+thread\+\_\+check()}}, \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}, and \mbox{\hyperlink{group__Eina__Types__Group_ga05c12dacc8b4058994df842b41be85fc}{EINA\+\_\+\+TRUE}}.

\mbox{\Hypertarget{group__Eio__Helper_ga5adda9eb0d7ea6a2cfb4cbc704f168b6}\label{group__Eio__Helper_ga5adda9eb0d7ea6a2cfb4cbc704f168b6}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_associate\_add@{eio\_file\_associate\_add}}
\index{eio\_file\_associate\_add@{eio\_file\_associate\_add}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_associate\_add()}{eio\_file\_associate\_add()}}
{\footnotesize\ttfamily EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} eio\+\_\+file\+\_\+associate\+\_\+add (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$}]{ls,  }\item[{const char $\ast$}]{key,  }\item[{const void $\ast$}]{data,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_gadbac560ba2bca5c61d97bfbb542018f3}{Eina\+\_\+\+Free\+\_\+\+Cb}}}]{free\+\_\+cb }\end{DoxyParamCaption})}



Associate data with the current filtered file. 


\begin{DoxyParams}{Parameters}
{\em ls} & The Eio\+\_\+\+File ls request currently calling the filter callback. \\
\hline
{\em key} & The key to associate data to. \\
\hline
{\em data} & The data to associate the data to. \\
\hline
{\em free\+\_\+cb} & Optionally a function to call to free the associated data, {\ttfamily data} is passed as the callback data parameter. If no {\ttfamily free\+\_\+cb} is provided the user {\ttfamily data} remains untouched. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
EINA\+\_\+\+TRUE if insertion was fine.
\end{DoxyReturn}
This function can only be safely called from within the filter callback. If you don\textquotesingle{}t need to copy the key around you can use \mbox{\hyperlink{group__Eio__Helper_ga21ba16681ee628f55693e5222713ef73}{eio\+\_\+file\+\_\+associate\+\_\+direct\+\_\+add}} 

References \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}, \mbox{\hyperlink{group__Eina__Hash__Group_ga5e72d0c5397936512407ce8cd66e98d6}{eina\+\_\+hash\+\_\+add()}}, \mbox{\hyperlink{group__Eina__Hash__Group_ga96bbbf394fb34d7e1f57d261de638e69}{eina\+\_\+hash\+\_\+string\+\_\+small\+\_\+new()}}, and \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}.

\mbox{\Hypertarget{group__Eio__Helper_ga21ba16681ee628f55693e5222713ef73}\label{group__Eio__Helper_ga21ba16681ee628f55693e5222713ef73}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_associate\_direct\_add@{eio\_file\_associate\_direct\_add}}
\index{eio\_file\_associate\_direct\_add@{eio\_file\_associate\_direct\_add}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_associate\_direct\_add()}{eio\_file\_associate\_direct\_add()}}
{\footnotesize\ttfamily EIO\+\_\+\+API \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} eio\+\_\+file\+\_\+associate\+\_\+direct\+\_\+add (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$}]{ls,  }\item[{const char $\ast$}]{key,  }\item[{const void $\ast$}]{data,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_gadbac560ba2bca5c61d97bfbb542018f3}{Eina\+\_\+\+Free\+\_\+\+Cb}}}]{free\+\_\+cb }\end{DoxyParamCaption})}



Associate data with the current filtered file. 


\begin{DoxyParams}{Parameters}
{\em ls} & The Eio\+\_\+\+File ls request currently calling the filter callback. \\
\hline
{\em 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). \\
\hline
{\em data} & The data to associate the data to. \\
\hline
{\em free\+\_\+cb} & The function to call to free the associated data, {\ttfamily free\+\_\+cb} will be called if not specified. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
EINA\+\_\+\+TRUE if insertion was fine.
\end{DoxyReturn}
This function can only be safely called from within the filter callback. If you need eio to make a proper copy of the {\ttfamily key} to be safe use \mbox{\hyperlink{group__Eio__Helper_ga5adda9eb0d7ea6a2cfb4cbc704f168b6}{eio\+\_\+file\+\_\+associate\+\_\+add}} instead. 

References \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}, \mbox{\hyperlink{group__Eina__Hash__Group_ga84a3b957ede675cb03f3c344695c1282}{eina\+\_\+hash\+\_\+direct\+\_\+add()}}, \mbox{\hyperlink{group__Eina__Hash__Group_ga96bbbf394fb34d7e1f57d261de638e69}{eina\+\_\+hash\+\_\+string\+\_\+small\+\_\+new()}}, and \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}.

\mbox{\Hypertarget{group__Eio__Helper_gac6522fcb1bb47013644513b25bba6f16}\label{group__Eio__Helper_gac6522fcb1bb47013644513b25bba6f16}} 
\index{Eio Reference helper API@{Eio Reference helper API}!eio\_file\_associate\_find@{eio\_file\_associate\_find}}
\index{eio\_file\_associate\_find@{eio\_file\_associate\_find}!Eio Reference helper API@{Eio Reference helper API}}
\doxysubsubsection{\texorpdfstring{eio\_file\_associate\_find()}{eio\_file\_associate\_find()}}
{\footnotesize\ttfamily EIO\+\_\+\+API void $\ast$ eio\+\_\+file\+\_\+associate\+\_\+find (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Eio_ga1145f009745ecb4d9f6a01a9bc5a9ac0}{Eio\+\_\+\+File}} $\ast$}]{ls,  }\item[{const char $\ast$}]{key }\end{DoxyParamCaption})}



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


\begin{DoxyParams}{Parameters}
{\em ls} & The Eio\+\_\+\+File ls request currently calling the notify callback. \\
\hline
{\em key} & The key pointing to the data to retrieve. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the data associated with the key or {\ttfamily NULL} if not found. 
\end{DoxyReturn}


References \mbox{\hyperlink{group__Eina__Hash__Group_ga6e9dc02a249e1fcdb64e38e7dc47afb3}{eina\+\_\+hash\+\_\+find()}}, and \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}.

