Home | History | Annotate | Download | only in gio 
      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 (at) redhat.com>
     21  */
     22 
     23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
     24 #error "Only <gio/gio.h> can be included directly."
     25 #endif
     26 
     27 #ifndef __G_DATA_OUTPUT_STREAM_H__
     28 #define __G_DATA_OUTPUT_STREAM_H__
     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  * @parent_instance: a #GBufferedOutputStream.
     44  *
     45  * An implementation of #GBufferedOutputStream that allows for high-level
     46  * data manipulation of arbitrary data (including binary operations).
     47  **/
     48 typedef struct _GDataOutputStream         GDataOutputStream;
     49 typedef struct _GDataOutputStreamClass    GDataOutputStreamClass;
     50 typedef struct _GDataOutputStreamPrivate  GDataOutputStreamPrivate;
     51 
     52 struct _GDataOutputStream
     53 {
     54   GFilterOutputStream parent_instance;
     55 
     56   /*< private >*/
     57   GDataOutputStreamPrivate *priv;
     58 };
     59 
     60 struct _GDataOutputStreamClass
     61 {
     62   GFilterOutputStreamClass parent_class;
     63 
     64   /*< private >*/
     65   /* Padding for future expansion */
     66   void (*_g_reserved1) (void);
     67   void (*_g_reserved2) (void);
     68   void (*_g_reserved3) (void);
     69   void (*_g_reserved4) (void);
     70   void (*_g_reserved5) (void);
     71 };
     72 
     73 
     74 GType                g_data_output_stream_get_type       (void) G_GNUC_CONST;
     75 GDataOutputStream *  g_data_output_stream_new            (GOutputStream         *base_stream);
     76 
     77 void                 g_data_output_stream_set_byte_order (GDataOutputStream     *stream,
     78 							  GDataStreamByteOrder   order);
     79 GDataStreamByteOrder g_data_output_stream_get_byte_order (GDataOutputStream     *stream);
     80 
     81 gboolean             g_data_output_stream_put_byte       (GDataOutputStream     *stream,
     82 							  guchar                 data,
     83 							  GCancellable          *cancellable,
     84 							  GError               **error);
     85 gboolean             g_data_output_stream_put_int16      (GDataOutputStream     *stream,
     86 							  gint16                 data,
     87 							  GCancellable          *cancellable,
     88 							  GError               **error);
     89 gboolean             g_data_output_stream_put_uint16     (GDataOutputStream     *stream,
     90 							  guint16                data,
     91 							  GCancellable          *cancellable,
     92 							  GError               **error);
     93 gboolean             g_data_output_stream_put_int32      (GDataOutputStream     *stream,
     94 							  gint32                 data,
     95 							  GCancellable          *cancellable,
     96 							  GError               **error);
     97 gboolean             g_data_output_stream_put_uint32     (GDataOutputStream     *stream,
     98 							  guint32                data,
     99 							  GCancellable          *cancellable,
    100 							  GError               **error);
    101 gboolean             g_data_output_stream_put_int64      (GDataOutputStream     *stream,
    102 							  gint64                 data,
    103 							  GCancellable          *cancellable,
    104 							  GError               **error);
    105 gboolean             g_data_output_stream_put_uint64     (GDataOutputStream     *stream,
    106 							  guint64                data,
    107 							  GCancellable          *cancellable,
    108 							  GError               **error);
    109 gboolean             g_data_output_stream_put_string     (GDataOutputStream     *stream,
    110 							  const char            *str,
    111 							  GCancellable          *cancellable,
    112 							  GError               **error);
    113 
    114 G_END_DECLS
    115 
    116 #endif /* __G_DATA_OUTPUT_STREAM_H__ */
    117