<refentry id="camel-CamelOfflineJournal">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelOfflineJournal.top_of_page">CamelOfflineJournal</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CamelOfflineJournal</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="camel-CamelOfflineJournal.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="CamelOfflineJournal">CamelOfflineJournal</link>;
                    <link linkend="CamelOfflineJournalEntry">CamelOfflineJournalEntry</link>;
<link linkend="void">void</link>                <link linkend="camel-offline-journal-construct">camel_offline_journal_construct</link>     (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         <link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder,
                                                         const <link linkend="char">char</link> *filename);
<link linkend="void">void</link>                <link linkend="camel-offline-journal-set-filename">camel_offline_journal_set_filename</link>  (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         const <link linkend="char">char</link> *filename);
<link linkend="int">int</link>                 <link linkend="camel-offline-journal-write">camel_offline_journal_write</link>         (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="int">int</link>                 <link linkend="camel-offline-journal-replay">camel_offline_journal_replay</link>        (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         <link linkend="CamelException">CamelException</link> *ex);
</synopsis>
</refsynopsisdiv>









<refsect1 id="camel-CamelOfflineJournal.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="camel-CamelOfflineJournal.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelOfflineJournal" role="struct">
<title>CamelOfflineJournal</title>
<indexterm zone="CamelOfflineJournal"><primary sortas="CamelOfflineJournal">CamelOfflineJournal</primary></indexterm><programlisting>typedef struct {
	CamelObject parent_object;
	
	struct _CamelFolder *folder;
	char *filename;
	CamelDList queue;
} CamelOfflineJournal;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelOfflineJournalEntry" role="struct">
<title>CamelOfflineJournalEntry</title>
<indexterm zone="CamelOfflineJournalEntry"><primary sortas="CamelOfflineJournalEntry">CamelOfflineJournalEntry</primary></indexterm><programlisting>typedef struct _CamelOfflineJournalEntry CamelOfflineJournalEntry;</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-offline-journal-construct" role="function">
<title>camel_offline_journal_construct ()</title>
<indexterm zone="camel-offline-journal-construct"><primary sortas="camel_offline_journal_construct">camel_offline_journal_construct</primary></indexterm><programlisting><link linkend="void">void</link>                camel_offline_journal_construct     (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         <link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder,
                                                         const <link linkend="char">char</link> *filename);</programlisting>
<para>
Constructs a journal object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>journal</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelOfflineJournal"><type>CamelOfflineJournal</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelFolder"><type>CamelFolder</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
<listitem><simpara> a filename to save/load the journal
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-offline-journal-set-filename" role="function">
<title>camel_offline_journal_set_filename ()</title>
<indexterm zone="camel-offline-journal-set-filename"><primary sortas="camel_offline_journal_set_filename">camel_offline_journal_set_filename</primary></indexterm><programlisting><link linkend="void">void</link>                camel_offline_journal_set_filename  (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         const <link linkend="char">char</link> *filename);</programlisting>
<para>
Set the filename where the journal should load/save from.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>journal</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelOfflineJournal"><type>CamelOfflineJournal</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
<listitem><simpara> a filename to load/save the journal to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-offline-journal-write" role="function">
<title>camel_offline_journal_write ()</title>
<indexterm zone="camel-offline-journal-write"><primary sortas="camel_offline_journal_write">camel_offline_journal_write</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_offline_journal_write         (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
Save the journal to disk.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>journal</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelOfflineJournal"><type>CamelOfflineJournal</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="0--CAPS"><literal>0</literal></link> on success or <link linkend="1--CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-offline-journal-replay" role="function">
<title>camel_offline_journal_replay ()</title>
<indexterm zone="camel-offline-journal-replay"><primary sortas="camel_offline_journal_replay">camel_offline_journal_replay</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_offline_journal_replay        (<link linkend="CamelOfflineJournal">CamelOfflineJournal</link> *journal,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
Replay all entries in the journal.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>journal</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelOfflineJournal"><type>CamelOfflineJournal</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="0--CAPS"><literal>0</literal></link> on success (no entry failed to replay) or <link linkend="1--CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
