Improve the g_file_make_symbolic_link docs
[platform/upstream/glib.git] / gio / gunixinputstream.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_UNIX_INPUT_STREAM_H__
24 #define __G_UNIX_INPUT_STREAM_H__
25
26 #include <gio/gio.h>
27
28 G_BEGIN_DECLS
29
30 #define G_TYPE_UNIX_INPUT_STREAM         (g_unix_input_stream_get_type ())
31 #define G_UNIX_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_UNIX_INPUT_STREAM, GUnixInputStream))
32 #define G_UNIX_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_UNIX_INPUT_STREAM, GUnixInputStreamClass))
33 #define G_IS_UNIX_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_UNIX_INPUT_STREAM))
34 #define G_IS_UNIX_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_UNIX_INPUT_STREAM))
35 #define G_UNIX_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_UNIX_INPUT_STREAM, GUnixInputStreamClass))
36
37 /**
38  * GUnixInputStream:
39  *
40  * Implements #GInputStream for reading from selectable unix file descriptors
41  **/
42 typedef struct _GUnixInputStream         GUnixInputStream;
43 typedef struct _GUnixInputStreamClass    GUnixInputStreamClass;
44 typedef struct _GUnixInputStreamPrivate  GUnixInputStreamPrivate;
45
46 struct _GUnixInputStream
47 {
48   GInputStream parent_instance;
49
50   /*< private >*/
51   GUnixInputStreamPrivate *priv;
52 };
53
54 struct _GUnixInputStreamClass
55 {
56   GInputStreamClass parent_class;
57
58   /*< private >*/
59   /* Padding for future expansion */
60   void (*_g_reserved1) (void);
61   void (*_g_reserved2) (void);
62   void (*_g_reserved3) (void);
63   void (*_g_reserved4) (void);
64   void (*_g_reserved5) (void);
65 };
66
67 GType          g_unix_input_stream_get_type     (void) G_GNUC_CONST;
68
69 GInputStream * g_unix_input_stream_new          (gint              fd,
70                                                  gboolean          close_fd);
71 void           g_unix_input_stream_set_close_fd (GUnixInputStream *stream,
72                                                  gboolean          close_fd);
73 gboolean       g_unix_input_stream_get_close_fd (GUnixInputStream *stream);
74 gint           g_unix_input_stream_get_fd       (GUnixInputStream *stream);
75
76 G_END_DECLS
77
78 #endif /* __G_UNIX_INPUT_STREAM_H__ */