gmime/gmime-stream-buffer.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_BUFFER_H__
  23 #define __GMIME_STREAM_BUFFER_H__
  24
  25 #include <gmime/gmime-stream.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GMIME_TYPE_STREAM_BUFFER            (g_mime_stream_buffer_get_type ())
  30 #define GMIME_STREAM_BUFFER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMIME_TYPE_STREAM_BUFFER, GMimeStreamBuffer))
  31 #define GMIME_STREAM_BUFFER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMIME_TYPE_STREAM_BUFFER, GMimeStreamBufferClass))
  32 #define GMIME_IS_STREAM_BUFFER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GMIME_TYPE_STREAM_BUFFER))
  33 #define GMIME_IS_STREAM_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GMIME_TYPE_STREAM_BUFFER))
  34 #define GMIME_STREAM_BUFFER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GMIME_TYPE_STREAM_BUFFER, GMimeStreamBufferClass))
  35
  36 typedef struct _GMimeStreamBuffer GMimeStreamBuffer;
  37 typedef struct _GMimeStreamBufferClass GMimeStreamBufferClass;
  38
  39
  40 /**
  41  * GMimeStreamBufferMode:
  42  * @GMIME_STREAM_BUFFER_CACHE_READ: Cache all reads.
  43  * @GMIME_STREAM_BUFFER_BLOCK_READ: Read in 4k blocks.
  44  * @GMIME_STREAM_BUFFER_BLOCK_WRITE: Write in 4k blocks.
  45  *
  46  * The buffering mode for a #GMimeStreamBuffer stream.
  47  **/
  48 typedef enum {
  49         GMIME_STREAM_BUFFER_CACHE_READ,
  50         GMIME_STREAM_BUFFER_BLOCK_READ,
  51         GMIME_STREAM_BUFFER_BLOCK_WRITE
  52 } GMimeStreamBufferMode;
  53
  54
  55 /**
  56  * GMimeStreamBuffer:
  57  * @parent_object: parent #GMimeStream
  58  * @mode: buffering mode
  59  * @source: source stream
  60  * @buffer: internal buffer
  61  * @bufptr: current position in the buffer
  62  * @bufend: end of the buffer
  63  * @buflen: buffer length
  64  *
  65  * A buffered stream wrapper around any #GMimeStream object.
  66  **/
  67 struct _GMimeStreamBuffer {
  68         GMimeStream parent_object;
  69
  70         GMimeStreamBufferMode mode;
  71         GMimeStream *source;
  72
  73         char *buffer;
  74         char *bufptr;
  75         char *bufend;
  76         size_t buflen;
  77 };
  78
  79 struct _GMimeStreamBufferClass {
  80         GMimeStreamClass parent_class;
  81
  82 };
  83
  84
  85 GType g_mime_stream_buffer_get_type (void);
  86
  87 GMimeStream *g_mime_stream_buffer_new (GMimeStream *source, GMimeStreamBufferMode mode);
  88
  89 ssize_t g_mime_stream_buffer_gets (GMimeStream *stream, char *buf, size_t max);
  90
  91 void    g_mime_stream_buffer_readln (GMimeStream *stream, GByteArray *buffer);
  92
  93 G_END_DECLS
  94
  95 #endif /* __GMIME_STREAM_BUFFER_H__ */