383 lines
15 KiB
XML
383 lines
15 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_journal_8c" xml:lang="en-US">
|
|
<title>src/journal.c File Reference</title>
|
|
<indexterm><primary>src/journal.c</primary></indexterm>
|
|
<para>
|
|
|
|
<para>journal / log </para>
|
|
|
|
</para>
|
|
<programlisting linenumbering="unnumbered">#include <stdio.h><?linebreak?>#include <stdlib.h><?linebreak?>#include <time.h><?linebreak?>#include <string.h><?linebreak?>#include <sys/time.h><?linebreak?>#include "../include/fsm.h"<?linebreak?></programlisting>Include dependency graph for journal.c:<para>
|
|
<informalfigure>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d3/d02/journal_8c__incl.png"></imagedata>
|
|
</imageobject>
|
|
</mediaobject>
|
|
</informalfigure>
|
|
</para>
|
|
<simplesect>
|
|
<title>Functions </title>
|
|
<itemizedlist>
|
|
<listitem><para>void <link linkend="_journal_8c_1ae6db4255fc3be03e0df09e7eda86b079">fsm_journal_init</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj)</para>
|
|
|
|
<para>init the journal </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_journal_8c_1af6738f8ff2fb7cb835d3ac62f1428c68">fsm_journal_clear</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj, const char *file_source, const char *function_source, const char *string_value)</para>
|
|
|
|
<para>usefulness ? (systematic ^c) </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_journal_8c_1a00a6887e7c3875580234d3a621589b72">fsm_journal_push_front</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj, const char *file_source, const char *function_source, const char *string_value)</para>
|
|
|
|
<para>add an event </para>
|
|
</listitem>
|
|
<listitem><para>long <link linkend="_journal_8c_1a9e063d297e80c32e2bac1ec04f24ecc2">fsm_journal_pop_back</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj, const char *file_source, const char *function_source, const char *string_value)</para>
|
|
|
|
<para>remove an event </para>
|
|
</listitem>
|
|
<listitem><para>int <link linkend="_journal_8c_1a2bc11a62378ff09ae3cbd8f40fa7fecd">fsm_journal_length</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</para>
|
|
|
|
<para>get journal_length </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_journal_8c_1aa414af4170798735875067122c33df8f">fsm_journal_seek</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj, long usec, const char *file_source, const char *function_source, const char *string_value)</para>
|
|
|
|
<para>seek for an event </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_journal_8c_1a76c4b511ecf3ddbc9e6d110641be665b">fsm_journal_publish</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</para>
|
|
|
|
<para>publish all the logs today just print in the console TODO > in a file </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>journal / log </para>
|
|
|
|
<para>This file is part of Gem-graph. The journal stores chronologically the events during a session run (rules exec, mainly)</para>
|
|
|
|
<para>What types of events should be reported ? (fsm, widgets, ... ) For what purpose ? What information must be collected and transmitted ? How to name and classify this information ? How to present it ?</para>
|
|
|
|
<para>date key (rank) source file source function +/- value</para>
|
|
|
|
<para>(notes) time_t current_time = time(NULL); < Check if the time retrieval was successful if (current_time == ((time_t)-1)) printf("Error getting current time.\n"); Convert to local time format and print printf(" Current timestamp: %ld %s\n", current_time, message); printf(" Current time: %s", ctime(&current_time)); </para>
|
|
</section>
|
|
<section>
|
|
<title>Function Documentation</title>
|
|
<anchor xml:id="_journal_8c_1af6738f8ff2fb7cb835d3ac62f1428c68"/><section>
|
|
<title>fsm_journal_clear()</title>
|
|
<indexterm><primary>fsm_journal_clear</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_clear</secondary></indexterm>
|
|
<para><computeroutput>void fsm_journal_clear (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para><para>
|
|
|
|
<para>usefulness ? (systematic ^c) </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*file_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*function_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*string_value</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_journal_8c_1ae6db4255fc3be03e0df09e7eda86b079"/><section>
|
|
<title>fsm_journal_init()</title>
|
|
<indexterm><primary>fsm_journal_init</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_init</secondary></indexterm>
|
|
<para><computeroutput>void fsm_journal_init (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj)</computeroutput></para><para>
|
|
|
|
<para>init the journal </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_journal_8c_1a2bc11a62378ff09ae3cbd8f40fa7fecd"/><section>
|
|
<title>fsm_journal_length()</title>
|
|
<indexterm><primary>fsm_journal_length</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_length</secondary></indexterm>
|
|
<para><computeroutput>int fsm_journal_length (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</computeroutput></para><para>
|
|
|
|
<para>get journal_length </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>journal length </para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_journal_8c_1a9e063d297e80c32e2bac1ec04f24ecc2"/><section>
|
|
<title>fsm_journal_pop_back()</title>
|
|
<indexterm><primary>fsm_journal_pop_back</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_pop_back</secondary></indexterm>
|
|
<para><computeroutput>long fsm_journal_pop_back (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para><para>
|
|
|
|
<para>remove an event </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*file_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*function_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*string_value</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_journal_8c_1a76c4b511ecf3ddbc9e6d110641be665b"/><section>
|
|
<title>fsm_journal_publish()</title>
|
|
<indexterm><primary>fsm_journal_publish</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_publish</secondary></indexterm>
|
|
<para><computeroutput>void fsm_journal_publish (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</computeroutput></para><para>
|
|
|
|
<para>publish all the logs today just print in the console TODO > in a file </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_journal_8c_1a00a6887e7c3875580234d3a621589b72"/><section>
|
|
<title>fsm_journal_push_front()</title>
|
|
<indexterm><primary>fsm_journal_push_front</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_push_front</secondary></indexterm>
|
|
<para><computeroutput>void fsm_journal_push_front (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para><para>
|
|
|
|
<para>add an event </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*file_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*function_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*string_value</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
<anchor xml:id="_journal_8c_1aa414af4170798735875067122c33df8f"/><section>
|
|
<title>fsm_journal_seek()</title>
|
|
<indexterm><primary>fsm_journal_seek</primary><secondary>journal.c</secondary></indexterm>
|
|
<indexterm><primary>journal.c</primary><secondary>fsm_journal_seek</secondary></indexterm>
|
|
<para><computeroutput>void fsm_journal_seek (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj, long usec, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para><para>
|
|
|
|
<para>seek for an event </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-09</para>
|
|
</formalpara>
|
|
|
|
<formalpara>
|
|
<title>
|
|
Parameters</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>*jj</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>usec</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*file_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*function_source</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>*string_value</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|