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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_DATA_OUTPUT_STREAM_H__
  22 #define __G_DATA_OUTPUT_STREAM_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/gfilteroutputstream.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  *
  42  * An implementation of #GBufferedOutputStream that allows for high-level
  43  * data manipulation of arbitrary data (including binary operations).
  44  **/
  45 typedef struct _GDataOutputStream         GDataOutputStream;
  46 typedef struct _GDataOutputStreamClass    GDataOutputStreamClass;
  47 typedef struct _GDataOutputStreamPrivate  GDataOutputStreamPrivate;
  48
  49 struct _GDataOutputStream
  50 {
  51   GFilterOutputStream parent_instance;
  52
  53   /*< private >*/
  54   GDataOutputStreamPrivate *priv;
  55 };
  56
  57 struct _GDataOutputStreamClass
  58 {
  59   GFilterOutputStreamClass parent_class;
  60
  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 GLIB_AVAILABLE_IN_ALL
  72 GType                g_data_output_stream_get_type       (void) G_GNUC_CONST;
  73 GLIB_AVAILABLE_IN_ALL
  74 GDataOutputStream *  g_data_output_stream_new            (GOutputStream         *base_stream);
  75
  76 GLIB_AVAILABLE_IN_ALL
  77 void                 g_data_output_stream_set_byte_order (GDataOutputStream     *stream,
  78                                                           GDataStreamByteOrder   order);
  79 GLIB_AVAILABLE_IN_ALL
  80 GDataStreamByteOrder g_data_output_stream_get_byte_order (GDataOutputStream     *stream);
  81
  82 GLIB_AVAILABLE_IN_ALL
  83 gboolean             g_data_output_stream_put_byte       (GDataOutputStream     *stream,
  84                                                           guchar                 data,
  85                                                           GCancellable          *cancellable,
  86                                                           GError               **error);
  87 GLIB_AVAILABLE_IN_ALL
  88 gboolean             g_data_output_stream_put_int16      (GDataOutputStream     *stream,
  89                                                           gint16                 data,
  90                                                           GCancellable          *cancellable,
  91                                                           GError               **error);
  92 GLIB_AVAILABLE_IN_ALL
  93 gboolean             g_data_output_stream_put_uint16     (GDataOutputStream     *stream,
  94                                                           guint16                data,
  95                                                           GCancellable          *cancellable,
  96                                                           GError               **error);
  97 GLIB_AVAILABLE_IN_ALL
  98 gboolean             g_data_output_stream_put_int32      (GDataOutputStream     *stream,
  99                                                           gint32                 data,
 100                                                           GCancellable          *cancellable,
 101                                                           GError               **error);
 102 GLIB_AVAILABLE_IN_ALL
 103 gboolean             g_data_output_stream_put_uint32     (GDataOutputStream     *stream,
 104                                                           guint32                data,
 105                                                           GCancellable          *cancellable,
 106                                                           GError               **error);
 107 GLIB_AVAILABLE_IN_ALL
 108 gboolean             g_data_output_stream_put_int64      (GDataOutputStream     *stream,
 109                                                           gint64                 data,
 110                                                           GCancellable          *cancellable,
 111                                                           GError               **error);
 112 GLIB_AVAILABLE_IN_ALL
 113 gboolean             g_data_output_stream_put_uint64     (GDataOutputStream     *stream,
 114                                                           guint64                data,
 115                                                           GCancellable          *cancellable,
 116                                                           GError               **error);
 117 GLIB_AVAILABLE_IN_ALL
 118 gboolean             g_data_output_stream_put_string     (GDataOutputStream     *stream,
 119                                                           const char            *str,
 120                                                           GCancellable          *cancellable,
 121                                                           GError               **error);
 122
 123 G_END_DECLS
 124
 125 #endif /* __G_DATA_OUTPUT_STREAM_H__ */