gmime/gmime-stream-mmap.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*  GMime
   3  *  Copyright (C) 2000-2012 Jeffrey Stedfast
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public License
   7  *  as published by the Free Software Foundation; either version 2.1
   8  *  of the License, or (at your option) any later version.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this library; if not, write to the Free
  17  *  Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  18  *  02110-1301, USA.
  19  */
  20
  21
  22 #ifndef __GMIME_STREAM_MMAP_H__
  23 #define __GMIME_STREAM_MMAP_H__
  24
  25 #include <gmime/gmime-stream.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GMIME_TYPE_STREAM_MMAP            (g_mime_stream_mmap_get_type ())
  30 #define GMIME_STREAM_MMAP(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMIME_TYPE_STREAM_MMAP, GMimeStreamMmap))
  31 #define GMIME_STREAM_MMAP_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMIME_TYPE_STREAM_MMAP, GMimeStreamMmapClass))
  32 #define GMIME_IS_STREAM_MMAP(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GMIME_TYPE_STREAM_MMAP))
  33 #define GMIME_IS_STREAM_MMAP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GMIME_TYPE_STREAM_MMAP))
  34 #define GMIME_STREAM_MMAP_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GMIME_TYPE_STREAM_MMAP, GMimeStreamMmapClass))
  35
  36 typedef struct _GMimeStreamMmap GMimeStreamMmap;
  37 typedef struct _GMimeStreamMmapClass GMimeStreamMmapClass;
  38
  39 /**
  40  * GMimeStreamMmap:
  41  * @parent_object: parent #GMimeStream
  42  * @owner: %TRUE if this stream owns the memory map
  43  * @eos: %TRUE if end-of-stream
  44  * @fd: file descriptor
  45  * @map: memory map
  46  * @maplen: length of the memory map
  47  *
  48  * A memory-mapped #GMimeStream.
  49  **/
  50 struct _GMimeStreamMmap {
  51         GMimeStream parent_object;
  52
  53         gboolean owner;
  54         gboolean eos;
  55         int fd;
  56
  57         char *map;
  58         size_t maplen;
  59 };
  60
  61 struct _GMimeStreamMmapClass {
  62         GMimeStreamClass parent_class;
  63
  64 };
  65
  66
  67 GType g_mime_stream_mmap_get_type (void);
  68
  69 GMimeStream *g_mime_stream_mmap_new (int fd, int prot, int flags);
  70 GMimeStream *g_mime_stream_mmap_new_with_bounds (int fd, int prot, int flags, gint64 start, gint64 end);
  71
  72 G_END_DECLS
  73
  74 #endif /* __GMIME_STREAM_MMAP_H__ */