camel/camel-offline-journal.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  *  Authors: Jeffrey Stedfast <fejj@novell.com>
   4  *
   5  *  Copyright 2004 Novell, Inc. (www.novell.com)
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU Lesser General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU Lesser General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU Lesser General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  *
  21  */
  22
  23
  24 #ifndef __CAMEL_OFFLINE_JOURNAL_H__
  25 #define __CAMEL_OFFLINE_JOURNAL_H__
  26
  27 #include <stdio.h>
  28 #include <stdarg.h>
  29
  30 #include <glib.h>
  31
  32 #include <libedataserver/e-msgport.h>
  33 #include <camel/camel-object.h>
  34
  35 #define CAMEL_TYPE_OFFLINE_JOURNAL            (camel_offline_journal_get_type ())
  36 #define CAMEL_OFFLINE_JOURNAL(obj)            (CAMEL_CHECK_CAST ((obj), CAMEL_TYPE_OFFLINE_JOURNAL, CamelOfflineJournal))
  37 #define CAMEL_OFFLINE_JOURNAL_CLASS(klass)    (CAMEL_CHECK_CLASS_CAST ((klass), CAMEL_TYPE_OFFLINE_JOURNAL, CamelOfflineJournalClass))
  38 #define CAMEL_IS_OFFLINE_JOURNAL(obj)         (CAMEL_CHECK_TYPE ((obj), CAMEL_TYPE_OFFLINE_JOURNAL))
  39 #define CAMEL_IS_OFFLINE_JOURNAL_CLASS(klass) (CAMEL_CHECK_CLASS_TYPE ((klass), CAMEL_TYPE_OFFLINE_JOURNAL))
  40 #define CAMEL_OFFLINE_JOURNAL_GET_CLASS(o) (CAMEL_OFFLINE_JOURNAL_CLASS (CAMEL_OBJECT_GET_CLASS (o)))
  41
  42 G_BEGIN_DECLS
  43
  44 typedef struct _CamelOfflineJournal CamelOfflineJournal;
  45 typedef struct _CamelOfflineJournalClass CamelOfflineJournalClass;
  46 typedef struct _CamelOfflineJournalEntry CamelOfflineJournalEntry;
  47
  48 struct _CamelFolder;
  49
  50 struct _CamelOfflineJournal {
  51         CamelObject parent_object;
  52
  53         struct _CamelFolder *folder;
  54         char *filename;
  55         EDList queue;
  56 };
  57
  58 struct _CamelOfflineJournalClass {
  59         CamelObjectClass parent_class;
  60
  61         /* entry methods */
  62         void (* entry_free) (CamelOfflineJournal *journal, EDListNode *entry);
  63
  64         EDListNode * (* entry_load) (CamelOfflineJournal *journal, FILE *in);
  65         int (* entry_write) (CamelOfflineJournal *journal, EDListNode *entry, FILE *out);
  66         int (* entry_play) (CamelOfflineJournal *journal, EDListNode *entry, CamelException *ex);
  67 };
  68
  69
  70 CamelType camel_offline_journal_get_type (void);
  71
  72 void camel_offline_journal_construct (CamelOfflineJournal *journal, struct _CamelFolder *folder, const char *filename);
  73 void camel_offline_journal_set_filename (CamelOfflineJournal *journal, const char *filename);
  74
  75 int camel_offline_journal_write (CamelOfflineJournal *journal, CamelException *ex);
  76 int camel_offline_journal_replay (CamelOfflineJournal *journal, CamelException *ex);
  77
  78 G_END_DECLS
  79
  80 #endif /* __CAMEL_OFFLINE_JOURNAL_H__ */