camel/camel-stream-fs.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /* camel-stream-fs.h :stream based on unix filesystem */
   3
   4 /*
   5  * Author:
   6  *  Bertrand Guiheneuf <bertrand@helixcode.com>
   7  *
   8  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of version 2 of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  22  * USA
  23  */
  24
  25 #if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
  26 #error "Only <camel/camel.h> can be included directly."
  27 #endif
  28
  29 #ifndef CAMEL_STREAM_FS_H
  30 #define CAMEL_STREAM_FS_H
  31
  32 /* for open flags */
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <fcntl.h>
  36
  37 #include <camel/camel-stream.h>
  38
  39 /* Standard GObject macros */
  40 #define CAMEL_TYPE_STREAM_FS \
  41         (camel_stream_fs_get_type ())
  42 #define CAMEL_STREAM_FS(obj) \
  43         (G_TYPE_CHECK_INSTANCE_CAST \
  44         ((obj), CAMEL_TYPE_STREAM_FS, CamelStreamFs))
  45 #define CAMEL_STREAM_FS_CLASS(cls) \
  46         (G_TYPE_CHECK_CLASS_CAST \
  47         ((cls), CAMEL_TYPE_STREAM_FS, CamelStreamFsClass))
  48 #define CAMEL_IS_STREAM_FS(obj) \
  49         (G_TYPE_CHECK_INSTANCE_TYPE \
  50         ((obj), CAMEL_TYPE_STREAM_FS))
  51 #define CAMEL_IS_STREAM_FS_CLASS(cls) \
  52         (G_TYPE_CHECK_CLASS_TYPE \
  53         ((cls), CAMEL_TYPE_STREAM_FS))
  54 #define CAMEL_STREAM_FS_GET_CLASS(obj) \
  55         (G_TYPE_INSTANCE_GET_CLASS \
  56         ((obj), CAMEL_TYPE_STREAM_FS, CamelStreamFsClass))
  57
  58 G_BEGIN_DECLS
  59
  60 typedef struct _CamelStreamFs CamelStreamFs;
  61 typedef struct _CamelStreamFsClass CamelStreamFsClass;
  62 typedef struct _CamelStreamFsPrivate CamelStreamFsPrivate;
  63
  64 struct _CamelStreamFs {
  65         CamelStream parent;
  66         CamelStreamFsPrivate *priv;
  67 };
  68
  69 struct _CamelStreamFsClass {
  70         CamelStreamClass parent_class;
  71 };
  72
  73 GType           camel_stream_fs_get_type        (void);
  74 CamelStream *   camel_stream_fs_new_with_name   (const gchar *name,
  75                                                  gint flags,
  76                                                  mode_t mode,
  77                                                  GError **error);
  78 CamelStream *   camel_stream_fs_new_with_fd     (gint fd);
  79 gint            camel_stream_fs_get_fd          (CamelStreamFs *stream);
  80
  81 G_END_DECLS
  82
  83 #endif /* CAMEL_STREAM_FS_H */