1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelOfflineJournal</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Folders.html" title="Folders">
<link rel="prev" href="camel-CamelOfflineFolder.html" title="CamelOfflineFolder">
<link rel="next" href="camel-CamelVeeFolder.html" title="CamelVeeFolder">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="classes.html" title="Part I. Camel Classes">
<link rel="chapter" href="ClassTree.html" title="Class hierarchy">
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
<link rel="chapter" href="Streams.html" title="Streams">
<link rel="chapter" href="Filters.html" title="Stream Filters">
<link rel="chapter" href="Services.html" title="Services">
<link rel="chapter" href="Folders.html" title="Folders">
<link rel="chapter" href="Addresses.html" title="Addresses">
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
<link rel="chapter" href="MIME.html" title="MIME Objects">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="camel-CamelOfflineFolder.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Folders.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-CamelVeeFolder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelOfflineJournal.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelOfflineJournal.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="camel-CamelOfflineJournal"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelOfflineJournal.top_of_page"></a>CamelOfflineJournal</span></h2>
<p>CamelOfflineJournal</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-CamelOfflineJournal.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a>;
<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournalEntry" title="CamelOfflineJournalEntry">CamelOfflineJournalEntry</a>;
void <a class="link" href="camel-CamelOfflineJournal.html#camel-offline-journal-construct" title="camel_offline_journal_construct ()">camel_offline_journal_construct</a> (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
struct _CamelFolder *folder,
const char *filename);
void <a class="link" href="camel-CamelOfflineJournal.html#camel-offline-journal-set-filename" title="camel_offline_journal_set_filename ()">camel_offline_journal_set_filename</a> (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
const char *filename);
int <a class="link" href="camel-CamelOfflineJournal.html#camel-offline-journal-write" title="camel_offline_journal_write ()">camel_offline_journal_write</a> (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
<a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
int <a class="link" href="camel-CamelOfflineJournal.html#camel-offline-journal-replay" title="camel_offline_journal_replay ()">camel_offline_journal_replay</a> (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
<a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="camel-CamelOfflineJournal.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="camel-CamelOfflineJournal.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="CamelOfflineJournal"></a><h3>CamelOfflineJournal</h3>
<pre class="programlisting">typedef struct {
CamelObject parent_object;
struct _CamelFolder *folder;
char *filename;
EDList queue;
} CamelOfflineJournal;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="CamelOfflineJournalEntry"></a><h3>CamelOfflineJournalEntry</h3>
<pre class="programlisting">typedef struct _CamelOfflineJournalEntry CamelOfflineJournalEntry;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="camel-offline-journal-construct"></a><h3>camel_offline_journal_construct ()</h3>
<pre class="programlisting">void camel_offline_journal_construct (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
struct _CamelFolder *folder,
const char *filename);</pre>
<p>
Constructs a journal object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td> a filename to save/load the journal
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="camel-offline-journal-set-filename"></a><h3>camel_offline_journal_set_filename ()</h3>
<pre class="programlisting">void camel_offline_journal_set_filename (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
const char *filename);</pre>
<p>
Set the filename where the journal should load/save from.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td> a filename to load/save the journal to
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="camel-offline-journal-write"></a><h3>camel_offline_journal_write ()</h3>
<pre class="programlisting">int camel_offline_journal_write (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
<a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
<p>
Save the journal to disk.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td> a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>%0 on success or <code class="literal">-1</code> on fail
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="camel-offline-journal-replay"></a><h3>camel_offline_journal_replay ()</h3>
<pre class="programlisting">int camel_offline_journal_replay (<a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal">CamelOfflineJournal</a> *journal,
<a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
<p>
Replay all entries in the journal.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelOfflineJournal.html#CamelOfflineJournal" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td> a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>%0 on success (no entry failed to replay) or <code class="literal">-1</code> on fail
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|