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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/gfilteroutputstream.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_DATA_OUTPUT_STREAM         (g_data_output_stream_get_type ())
  35 #define G_DATA_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStream))
  36 #define G_DATA_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStreamClass))
  37 #define G_IS_DATA_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DATA_OUTPUT_STREAM))
  38 #define G_IS_DATA_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DATA_OUTPUT_STREAM))
  39 #define G_DATA_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStreamClass))
  40
  41 /**
  42  * GDataOutputStream:
  43  *
  44  * An implementation of #GBufferedOutputStream that allows for high-level
  45  * data manipulation of arbitrary data (including binary operations).
  46  **/
  47 typedef struct _GDataOutputStream         GDataOutputStream;
  48 typedef struct _GDataOutputStreamClass    GDataOutputStreamClass;
  49 typedef struct _GDataOutputStreamPrivate  GDataOutputStreamPrivate;
  50
  51 struct _GDataOutputStream
  52 {
  53   GFilterOutputStream parent_instance;
  54
  55   /*< private >*/
  56   GDataOutputStreamPrivate *priv;
  57 };
  58
  59 struct _GDataOutputStreamClass
  60 {
  61   GFilterOutputStreamClass parent_class;
  62
  63   /*< private >*/
  64   /* Padding for future expansion */
  65   void (*_g_reserved1) (void);
  66   void (*_g_reserved2) (void);
  67   void (*_g_reserved3) (void);
  68   void (*_g_reserved4) (void);
  69   void (*_g_reserved5) (void);
  70 };
  71
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 GType                g_data_output_stream_get_type       (void) G_GNUC_CONST;
  75 GLIB_AVAILABLE_IN_ALL
  76 GDataOutputStream *  g_data_output_stream_new            (GOutputStream         *base_stream);
  77
  78 GLIB_AVAILABLE_IN_ALL
  79 void                 g_data_output_stream_set_byte_order (GDataOutputStream     *stream,
  80                                                           GDataStreamByteOrder   order);
  81 GLIB_AVAILABLE_IN_ALL
  82 GDataStreamByteOrder g_data_output_stream_get_byte_order (GDataOutputStream     *stream);
  83
  84 GLIB_AVAILABLE_IN_ALL
  85 gboolean             g_data_output_stream_put_byte       (GDataOutputStream     *stream,
  86                                                           guchar                 data,
  87                                                           GCancellable          *cancellable,
  88                                                           GError               **error);
  89 GLIB_AVAILABLE_IN_ALL
  90 gboolean             g_data_output_stream_put_int16      (GDataOutputStream     *stream,
  91                                                           gint16                 data,
  92                                                           GCancellable          *cancellable,
  93                                                           GError               **error);
  94 GLIB_AVAILABLE_IN_ALL
  95 gboolean             g_data_output_stream_put_uint16     (GDataOutputStream     *stream,
  96                                                           guint16                data,
  97                                                           GCancellable          *cancellable,
  98                                                           GError               **error);
  99 GLIB_AVAILABLE_IN_ALL
 100 gboolean             g_data_output_stream_put_int32      (GDataOutputStream     *stream,
 101                                                           gint32                 data,
 102                                                           GCancellable          *cancellable,
 103                                                           GError               **error);
 104 GLIB_AVAILABLE_IN_ALL
 105 gboolean             g_data_output_stream_put_uint32     (GDataOutputStream     *stream,
 106                                                           guint32                data,
 107                                                           GCancellable          *cancellable,
 108                                                           GError               **error);
 109 GLIB_AVAILABLE_IN_ALL
 110 gboolean             g_data_output_stream_put_int64      (GDataOutputStream     *stream,
 111                                                           gint64                 data,
 112                                                           GCancellable          *cancellable,
 113                                                           GError               **error);
 114 GLIB_AVAILABLE_IN_ALL
 115 gboolean             g_data_output_stream_put_uint64     (GDataOutputStream     *stream,
 116                                                           guint64                data,
 117                                                           GCancellable          *cancellable,
 118                                                           GError               **error);
 119 GLIB_AVAILABLE_IN_ALL
 120 gboolean             g_data_output_stream_put_string     (GDataOutputStream     *stream,
 121                                                           const char            *str,
 122                                                           GCancellable          *cancellable,
 123                                                           GError               **error);
 124
 125 G_END_DECLS
 126
 127 #endif /* __G_DATA_OUTPUT_STREAM_H__ */