gdataoutputstream.h 4.81 KB
Newer Older
1
/* GIO - GLib Input, Output and Streaming Library
2
 *
3 4 5 6 7 8 9 10 11 12 13 14 15
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

21 22 23
#ifndef __G_DATA_OUTPUT_STREAM_H__
#define __G_DATA_OUTPUT_STREAM_H__

24 25 26 27
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

28 29 30 31 32 33 34 35 36 37 38
#include <gio/gfilteroutputstream.h>

G_BEGIN_DECLS

#define G_TYPE_DATA_OUTPUT_STREAM         (g_data_output_stream_get_type ())
#define G_DATA_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStream))
#define G_DATA_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStreamClass))
#define G_IS_DATA_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DATA_OUTPUT_STREAM))
#define G_IS_DATA_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DATA_OUTPUT_STREAM))
#define G_DATA_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DATA_OUTPUT_STREAM, GDataOutputStreamClass))

39 40 41
/**
 * GDataOutputStream:
 *
42
 * An implementation of #GBufferedOutputStream that allows for high-level
43 44
 * data manipulation of arbitrary data (including binary operations).
 **/
45 46 47 48 49 50
typedef struct _GDataOutputStream         GDataOutputStream;
typedef struct _GDataOutputStreamClass    GDataOutputStreamClass;
typedef struct _GDataOutputStreamPrivate  GDataOutputStreamPrivate;

struct _GDataOutputStream
{
51
  GFilterOutputStream parent_instance;
52 53 54 55 56 57 58

  /*< private >*/
  GDataOutputStreamPrivate *priv;
};

struct _GDataOutputStreamClass
{
59 60
  GFilterOutputStreamClass parent_class;

61
  /*< private >*/
62 63 64 65 66 67 68 69 70
  /* Padding for future expansion */
  void (*_g_reserved1) (void);
  void (*_g_reserved2) (void);
  void (*_g_reserved3) (void);
  void (*_g_reserved4) (void);
  void (*_g_reserved5) (void);
};


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
Matthias Clasen's avatar
Matthias Clasen committed
77
void                 g_data_output_stream_set_byte_order (GDataOutputStream     *stream,
78
							  GDataStreamByteOrder   order);
79
GLIB_AVAILABLE_IN_ALL
80 81
GDataStreamByteOrder g_data_output_stream_get_byte_order (GDataOutputStream     *stream);

82
GLIB_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
83
gboolean             g_data_output_stream_put_byte       (GDataOutputStream     *stream,
84 85 86
							  guchar                 data,
							  GCancellable          *cancellable,
							  GError               **error);
87
GLIB_AVAILABLE_IN_ALL
88 89 90 91
gboolean             g_data_output_stream_put_int16      (GDataOutputStream     *stream,
							  gint16                 data,
							  GCancellable          *cancellable,
							  GError               **error);
92
GLIB_AVAILABLE_IN_ALL
93 94 95 96
gboolean             g_data_output_stream_put_uint16     (GDataOutputStream     *stream,
							  guint16                data,
							  GCancellable          *cancellable,
							  GError               **error);
97
GLIB_AVAILABLE_IN_ALL
98 99 100 101
gboolean             g_data_output_stream_put_int32      (GDataOutputStream     *stream,
							  gint32                 data,
							  GCancellable          *cancellable,
							  GError               **error);
102
GLIB_AVAILABLE_IN_ALL
103 104 105 106
gboolean             g_data_output_stream_put_uint32     (GDataOutputStream     *stream,
							  guint32                data,
							  GCancellable          *cancellable,
							  GError               **error);
107
GLIB_AVAILABLE_IN_ALL
108 109 110 111
gboolean             g_data_output_stream_put_int64      (GDataOutputStream     *stream,
							  gint64                 data,
							  GCancellable          *cancellable,
							  GError               **error);
112
GLIB_AVAILABLE_IN_ALL
113 114 115 116
gboolean             g_data_output_stream_put_uint64     (GDataOutputStream     *stream,
							  guint64                data,
							  GCancellable          *cancellable,
							  GError               **error);
117
GLIB_AVAILABLE_IN_ALL
118 119 120 121 122 123 124 125
gboolean             g_data_output_stream_put_string     (GDataOutputStream     *stream,
							  const char            *str,
							  GCancellable          *cancellable,
							  GError               **error);

G_END_DECLS

#endif /* __G_DATA_OUTPUT_STREAM_H__ */