gem-graph-client/doc/docbook/d3/d0c/journal_8c.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 &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;time.h&gt;<?linebreak?>#include &lt;string.h&gt;<?linebreak?>#include &lt;sys/time.h&gt;<?linebreak?>#include &quot;../include/fsm.h&quot;<?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.svg"></imagedata>
            </imageobject>
        </mediaobject>
    </informalfigure>
</para>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>void <link linkend="_journal_8c_1acc1d20291e2f32ff5e7af4c95629e28e">fsm_init_log</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_1af84a8278ff74e2a6f652f8a6d8dacff7">fsm__clear_log</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_1adfe571927cb823d409f59d1c8678e640">fsm_add_log</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_1a8a005b11601891a81e534b84aab336ff">fsm_pop_back_log</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_1a878d12a6fded3d172b59fdfc28dcca85">fsm_length_log</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_1a2a991ccb47f1e8ed7eaec22bb42e5d7a">fsm_seek_log</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_1a7d5e93d1dd1368afb4a46c8c0b0cb506">fsm_publish_log</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</para>

<para>publish all the logs today just print in the console TODO &gt; 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); &lt; Check if the time retrieval was successful if (current_time == ((time_t)-1)) printf(&quot;Error getting current time.\n&quot;); Convert to local time format and print printf(&quot;    Current timestamp: %ld  %s\n&quot;, current_time, message); printf(&quot;    Current time: %s&quot;, ctime(&amp;current_time)); </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_journal_8c_1af84a8278ff74e2a6f652f8a6d8dacff7"/><section>
    <title>fsm__clear_log()</title>
<indexterm><primary>fsm__clear_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm__clear_log</secondary></indexterm>
<para><computeroutput>void fsm__clear_log (<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_1adfe571927cb823d409f59d1c8678e640"/><section>
    <title>fsm_add_log()</title>
<indexterm><primary>fsm_add_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_add_log</secondary></indexterm>
<para><computeroutput>void fsm_add_log (<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>
Here is the caller graph for this function:<para>
    <informalfigure>
        <mediaobject>
            <imageobject>
                <imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d3/d0c/journal_8c_adfe571927cb823d409f59d1c8678e640_icgraph.svg"></imagedata>
            </imageobject>
        </mediaobject>
    </informalfigure>
</para>
</section>
<anchor xml:id="_journal_8c_1acc1d20291e2f32ff5e7af4c95629e28e"/><section>
    <title>fsm_init_log()</title>
<indexterm><primary>fsm_init_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_init_log</secondary></indexterm>
<para><computeroutput>void fsm_init_log (<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>
Here is the caller graph for this function:<para>
    <informalfigure>
        <mediaobject>
            <imageobject>
                <imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d3/d0c/journal_8c_acc1d20291e2f32ff5e7af4c95629e28e_icgraph.svg"></imagedata>
            </imageobject>
        </mediaobject>
    </informalfigure>
</para>
</section>
<anchor xml:id="_journal_8c_1a878d12a6fded3d172b59fdfc28dcca85"/><section>
    <title>fsm_length_log()</title>
<indexterm><primary>fsm_length_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_length_log</secondary></indexterm>
<para><computeroutput>int fsm_length_log (<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_1a8a005b11601891a81e534b84aab336ff"/><section>
    <title>fsm_pop_back_log()</title>
<indexterm><primary>fsm_pop_back_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_pop_back_log</secondary></indexterm>
<para><computeroutput>long fsm_pop_back_log (<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_1a7d5e93d1dd1368afb4a46c8c0b0cb506"/><section>
    <title>fsm_publish_log()</title>
<indexterm><primary>fsm_publish_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_publish_log</secondary></indexterm>
<para><computeroutput>void fsm_publish_log (<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 &gt; 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>
Here is the caller graph for this function:<para>
    <informalfigure>
        <mediaobject>
            <imageobject>
                <imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d3/d0c/journal_8c_a7d5e93d1dd1368afb4a46c8c0b0cb506_icgraph.svg"></imagedata>
            </imageobject>
        </mediaobject>
    </informalfigure>
</para>
</section>
<anchor xml:id="_journal_8c_1a2a991ccb47f1e8ed7eaec22bb42e5d7a"/><section>
    <title>fsm_seek_log()</title>
<indexterm><primary>fsm_seek_log</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_seek_log</secondary></indexterm>
<para><computeroutput>void fsm_seek_log (<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>