gio/gdataoutputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   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
   7  * License as published by the Free Software Foundation; either
   8  * version 2 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
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_DATA_OUTPUT_STREAM_H__
  24 #define __G_DATA_OUTPUT_STREAM_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gfilteroutputstream.h>
  28 #include <gio/gdatainputstream.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_DATA_OUTPUT_STREAM         (g_data_output_stream_get_type ())
  33 #define G_DATA_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStream))
  34 #define G_DATA_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStreamClass))
  35 #define G_IS_DATA_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DATA_OUTPUT_STREAM))
  36 #define G_IS_DATA_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DATA_OUTPUT_STREAM))
  37 #define G_DATA_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStreamClass))
  38
  39 /**
  40  * GDataOutputStream:
  41  * @parent: a #GBufferedOutputStream.
  42  *
  43  * An implementation of #GBufferedOutputStream that allows for high-level
  44  * data manipulation of arbitrary data (including binary operations).
  45  **/
  46 typedef struct _GDataOutputStream         GDataOutputStream;
  47 typedef struct _GDataOutputStreamClass    GDataOutputStreamClass;
  48 typedef struct _GDataOutputStreamPrivate  GDataOutputStreamPrivate;
  49
  50 struct _GDataOutputStream
  51 {
  52   GFilterOutputStream parent;
  53
  54   /*< private >*/
  55   GDataOutputStreamPrivate *priv;
  56 };
  57
  58 struct _GDataOutputStreamClass
  59 {
  60  GFilterOutputStreamClass parent_class;
  61   /*< private >*/
  62   /* Padding for future expansion */
  63   void (*_g_reserved1) (void);
  64   void (*_g_reserved2) (void);
  65   void (*_g_reserved3) (void);
  66   void (*_g_reserved4) (void);
  67   void (*_g_reserved5) (void);
  68 };
  69
  70
  71 GType          g_data_output_stream_get_type   (void) G_GNUC_CONST;
  72 GDataOutputStream*  g_data_output_stream_new        (GOutputStream *base_stream);
  73
  74 void                 g_data_output_stream_set_byte_order (GDataOutputStream     *data_stream,
  75                                                           GDataStreamByteOrder   order);
  76 GDataStreamByteOrder g_data_output_stream_get_byte_order (GDataOutputStream     *stream);
  77 void                 g_data_output_stream_set_expand_buffer (GDataOutputStream     *data_stream,
  78                                                              gboolean               expand_buffer);
  79
  80 gboolean             g_data_output_stream_put_byte       (GDataOutputStream     *data_stream,
  81                                                           guchar                 data,
  82                                                           GCancellable          *cancellable,
  83                                                           GError               **error);
  84 gboolean             g_data_output_stream_put_int16      (GDataOutputStream     *stream,
  85                                                           gint16                 data,
  86                                                           GCancellable          *cancellable,
  87                                                           GError               **error);
  88 gboolean             g_data_output_stream_put_uint16     (GDataOutputStream     *stream,
  89                                                           guint16                data,
  90                                                           GCancellable          *cancellable,
  91                                                           GError               **error);
  92 gboolean             g_data_output_stream_put_int32      (GDataOutputStream     *stream,
  93                                                           gint32                 data,
  94                                                           GCancellable          *cancellable,
  95                                                           GError               **error);
  96 gboolean             g_data_output_stream_put_uint32     (GDataOutputStream     *stream,
  97                                                           guint32                data,
  98                                                           GCancellable          *cancellable,
  99                                                           GError               **error);
 100 gboolean             g_data_output_stream_put_int64      (GDataOutputStream     *stream,
 101                                                           gint64                 data,
 102                                                           GCancellable          *cancellable,
 103                                                           GError               **error);
 104 gboolean             g_data_output_stream_put_uint64     (GDataOutputStream     *stream,
 105                                                           guint64                data,
 106                                                           GCancellable          *cancellable,
 107                                                           GError               **error);
 108 gboolean             g_data_output_stream_put_string     (GDataOutputStream     *stream,
 109                                                           const char            *str,
 110                                                           GCancellable          *cancellable,
 111                                                           GError               **error);
 112
 113 G_END_DECLS
 114
 115 #endif /* __G_DATA_OUTPUT_STREAM_H__ */