\hypertarget{group__Eina__Evlog}{}\section{Event Log Debugging}
\label{group__Eina__Evlog}\index{Event Log Debugging@{Event Log Debugging}}


These functions are use internally by E\+FL in general for profiling.  


\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{struct__Eina__Evlog__Item}{\+\_\+\+Eina\+\_\+\+Evlog\+\_\+\+Item}
\item 
struct \hyperlink{struct__Eina__Evlog__Buf}{\+\_\+\+Eina\+\_\+\+Evlog\+\_\+\+Buf}
\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef struct \hyperlink{struct__Eina__Evlog__Item}{\+\_\+\+Eina\+\_\+\+Evlog\+\_\+\+Item} {\bfseries Eina\+\_\+\+Evlog\+\_\+\+Item}\hypertarget{group__Eina__Evlog_gabbaa60bab581d3b6356886cf430983cb}{}\label{group__Eina__Evlog_gabbaa60bab581d3b6356886cf430983cb}

\item 
typedef struct \hyperlink{struct__Eina__Evlog__Buf}{\+\_\+\+Eina\+\_\+\+Evlog\+\_\+\+Buf} {\bfseries Eina\+\_\+\+Evlog\+\_\+\+Buf}\hypertarget{group__Eina__Evlog_gaf23eb6c706626c2cc4d357a22ee4e366}{}\label{group__Eina__Evlog_gaf23eb6c706626c2cc4d357a22ee4e366}

\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__Eina__Evlog_ga447074742775e3ce764164de4721dfa5}{eina\+\_\+evlog} (const char $\ast$event, void $\ast$obj, double srctime, const char $\ast$detail)
\begin{DoxyCompactList}\small\item\em Log an event in our event log for profiling data. \end{DoxyCompactList}\item 
\hyperlink{struct__Eina__Evlog__Buf}{Eina\+\_\+\+Evlog\+\_\+\+Buf} $\ast$ \hyperlink{group__Eina__Evlog_ga6bcceb937149d830011beec88f94d4db}{eina\+\_\+evlog\+\_\+steal} (void)
\begin{DoxyCompactList}\small\item\em Steal an event log buffer from the evlog core. \end{DoxyCompactList}\item 
void \hyperlink{group__Eina__Evlog_ga1a07cd71f2717781580d7226eb8a8a2c}{eina\+\_\+evlog\+\_\+start} (void)
\begin{DoxyCompactList}\small\item\em Begin logging -\/ until now eina\+\_\+evlog is a N\+O\+OP. \end{DoxyCompactList}\item 
void \hyperlink{group__Eina__Evlog_gac87eddcf8e0be9e55f1224f3e736bdc9}{eina\+\_\+evlog\+\_\+stop} (void)
\begin{DoxyCompactList}\small\item\em Stop logging. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
These functions are use internally by E\+FL in general for profiling. 

This A\+PI is not considered stable or intended for use outside of E\+FL itself at this stage, so do not use this unless you wish to keep up. The format of debug logs may and likely will change as this feature matures.

\begin{DoxySince}{Since}
1.\+15 
\end{DoxySince}


\subsection{Function Documentation}
\index{Event Log Debugging@{Event Log Debugging}!eina\+\_\+evlog@{eina\+\_\+evlog}}
\index{eina\+\_\+evlog@{eina\+\_\+evlog}!Event Log Debugging@{Event Log Debugging}}
\subsubsection[{\texorpdfstring{eina\+\_\+evlog(const char $\ast$event, void $\ast$obj, double srctime, const char $\ast$detail)}{eina_evlog(const char *event, void *obj, double srctime, const char *detail)}}]{\setlength{\rightskip}{0pt plus 5cm}void eina\+\_\+evlog (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{event, }
\item[{void $\ast$}]{obj, }
\item[{double}]{srctime, }
\item[{const char $\ast$}]{detail}
\end{DoxyParamCaption}
)}\hypertarget{group__Eina__Evlog_ga447074742775e3ce764164de4721dfa5}{}\label{group__Eina__Evlog_ga447074742775e3ce764164de4721dfa5}


Log an event in our event log for profiling data. 

Log some interesting event inside of E\+FL, eg a wakeup (and why etc.). The {\ttfamily event} string must alwasy be provided and be of the form\+:

\char`\"{}+eventname\char`\"{} \char`\"{}-\/eventname\char`\"{} \char`\"{}$>$eventname\char`\"{} \char`\"{}$<$eventname\char`\"{} \char`\"{}!eventname\char`\"{} \char`\"{}$\ast$eventname\char`\"{}

etc. The \char`\"{}+\char`\"{} char means an event is beginning (and any subsequent events logged are really children of this event). The \char`\"{}-\/\char`\"{} char means an event is ending and so all child events S\+H\+O\+U\+LD have ended by now. A \char`\"{}!\char`\"{} character means the event is a one-\/off with no beginning or end. A\char`\"{}$\ast$\char`\"{} Means this is special metadata and the defail field may need special parsing based on the eventname, so ignroe unless known. A \char`\"{}$>$\char`\"{} character means we begin this \char`\"{}state\char`\"{} of the process (these are separate to \char`\"{}+\char`\"{} and \char`\"{}-\/\char`\"{} events and don\textquotesingle{}t nest -\/ arenot related to a thread or any other event, but just a state). \char`\"{}$<$\char`\"{} Ends the given state given by the \char`\"{}eventname\char`\"{} spart of the string. Any string following this initial character is the event or state name (and must be provided in the exact same string at both \char`\"{}+\char`\"{}, \char`\"{}$<$\char`\"{} and \char`\"{}-\/\char`\"{}, \char`\"{}$>$\char`\"{} events). This is what will be displayed in a debugger (and may be a well known string thus given a nice UI flourish with icons, labels and colors, so don\textquotesingle{}t change this string unless you want to impact such visibility of these events). The event string after the first character as above can be anything, including white space. It is suggested to keep it human readable and as short as feasible.

The {\ttfamily object} is optional, and if not used, pass in N\+U\+LL. If it is used, it can be a pointer to anything. It is intended simply to be of use to indicate an event happens on object A vs object B. What this points to is irrelevant as the pointer is never de-\/references or used other than as a label to differentiate an event on 2 different objects.

The {\ttfamily srctime} parameter is 0.\+0 if not used, or if used, contains a timepoint for an event that triggered this one. For example, if a device or hardware interrupt causes this event, that device may provide a timestamp/timepoint as part of the device information to indicate the exact time the hardware interrupt happened. This can be useful to have more information as to the latency of an actual source of an event such as the hardware interrupt time, and when the code actually begins seeing or processing it.

The {\ttfamily detail} string is optional (and if unused should be N\+U\+LL). This is for providing more detailed information to log such as perhaps a the state at the time of the log events or a series of parameters and input that caused this event.


\begin{DoxyParams}{Parameters}
{\em event} & The event string -\/ see above for format \\
\hline
{\em obj} & An optional object \char`\"{}pointer\char`\"{} to associate \\
\hline
{\em srctime} & An optional source event timestamp that caused this event \\
\hline
{\em detail} & An optional event detail string with more info\\
\hline
\end{DoxyParams}
\begin{DoxySince}{Since}
1.\+15 
\end{DoxySince}


Referenced by ecore\+\_\+event\+\_\+current\+\_\+event\+\_\+get(), ecore\+\_\+idle\+\_\+enterer\+\_\+del(), ecore\+\_\+idle\+\_\+exiter\+\_\+del(), ecore\+\_\+idler\+\_\+del(), ecore\+\_\+main\+\_\+fd\+\_\+handler\+\_\+active\+\_\+set(), ecore\+\_\+main\+\_\+loop\+\_\+begin(), ecore\+\_\+throttle\+\_\+get(), ecore\+\_\+timer\+\_\+dump(), eina\+\_\+init(), and evas\+\_\+render\+\_\+updates\+\_\+free().

\index{Event Log Debugging@{Event Log Debugging}!eina\+\_\+evlog\+\_\+steal@{eina\+\_\+evlog\+\_\+steal}}
\index{eina\+\_\+evlog\+\_\+steal@{eina\+\_\+evlog\+\_\+steal}!Event Log Debugging@{Event Log Debugging}}
\subsubsection[{\texorpdfstring{eina\+\_\+evlog\+\_\+steal(void)}{eina_evlog_steal(void)}}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Eina\+\_\+\+Evlog\+\_\+\+Buf}$\ast$ eina\+\_\+evlog\+\_\+steal (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\hypertarget{group__Eina__Evlog_ga6bcceb937149d830011beec88f94d4db}{}\label{group__Eina__Evlog_ga6bcceb937149d830011beec88f94d4db}


Steal an event log buffer from the evlog core. 

Only one buffer can be stolen at any time. If you steal a new buffer, the old stolen buffer is \char`\"{}released\char`\"{} back to the evlog core.

\begin{DoxyReturn}{Returns}
The stolen evlog buffer
\end{DoxyReturn}
\begin{DoxySince}{Since}
1.\+15 
\end{DoxySince}
\index{Event Log Debugging@{Event Log Debugging}!eina\+\_\+evlog\+\_\+start@{eina\+\_\+evlog\+\_\+start}}
\index{eina\+\_\+evlog\+\_\+start@{eina\+\_\+evlog\+\_\+start}!Event Log Debugging@{Event Log Debugging}}
\subsubsection[{\texorpdfstring{eina\+\_\+evlog\+\_\+start(void)}{eina_evlog_start(void)}}]{\setlength{\rightskip}{0pt plus 5cm}void eina\+\_\+evlog\+\_\+start (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\hypertarget{group__Eina__Evlog_ga1a07cd71f2717781580d7226eb8a8a2c}{}\label{group__Eina__Evlog_ga1a07cd71f2717781580d7226eb8a8a2c}


Begin logging -\/ until now eina\+\_\+evlog is a N\+O\+OP. 

\begin{DoxySince}{Since}
1.\+15 
\end{DoxySince}
\index{Event Log Debugging@{Event Log Debugging}!eina\+\_\+evlog\+\_\+stop@{eina\+\_\+evlog\+\_\+stop}}
\index{eina\+\_\+evlog\+\_\+stop@{eina\+\_\+evlog\+\_\+stop}!Event Log Debugging@{Event Log Debugging}}
\subsubsection[{\texorpdfstring{eina\+\_\+evlog\+\_\+stop(void)}{eina_evlog_stop(void)}}]{\setlength{\rightskip}{0pt plus 5cm}void eina\+\_\+evlog\+\_\+stop (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\hypertarget{group__Eina__Evlog_gac87eddcf8e0be9e55f1224f3e736bdc9}{}\label{group__Eina__Evlog_gac87eddcf8e0be9e55f1224f3e736bdc9}


Stop logging. 

You must not be using any evlog buffers stolen by \hyperlink{group__Eina__Evlog_ga6bcceb937149d830011beec88f94d4db}{eina\+\_\+evlog\+\_\+steal()} by the time you call this function.

\begin{DoxySince}{Since}
1.\+15 
\end{DoxySince}


References E\+I\+N\+A\+\_\+\+T\+R\+UE.

