1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.UnixInputStream;
26 
27 private import gio.FileDescriptorBasedIF;
28 private import gio.FileDescriptorBasedT;
29 private import gio.InputStream;
30 private import gio.PollableInputStreamIF;
31 private import gio.PollableInputStreamT;
32 private import glib.ConstructionException;
33 private import gobject.ObjectG;
34 private import gtkc.gio;
35 public  import gtkc.giotypes;
36 
37 
38 /**
39  * #GUnixInputStream implements #GInputStream for reading from a UNIX
40  * file descriptor, including asynchronous operations. (If the file
41  * descriptor refers to a socket or pipe, this will use poll() to do
42  * asynchronous I/O. If it refers to a regular file, it will fall back
43  * to doing asynchronous I/O in another thread.)
44  * 
45  * Note that `<gio/gunixinputstream.h>` belongs to the UNIX-specific GIO
46  * interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
47  * file when using it.
48  */
49 public class UnixInputStream : InputStream, FileDescriptorBasedIF, PollableInputStreamIF
50 {
51 	/** the main Gtk struct */
52 	protected GUnixInputStream* gUnixInputStream;
53 
54 	/** Get the main Gtk struct */
55 	public GUnixInputStream* getUnixInputStreamStruct()
56 	{
57 		return gUnixInputStream;
58 	}
59 
60 	/** the main Gtk struct as a void* */
61 	protected override void* getStruct()
62 	{
63 		return cast(void*)gUnixInputStream;
64 	}
65 
66 	protected override void setStruct(GObject* obj)
67 	{
68 		gUnixInputStream = cast(GUnixInputStream*)obj;
69 		super.setStruct(obj);
70 	}
71 
72 	/**
73 	 * Sets our main struct and passes it to the parent class.
74 	 */
75 	public this (GUnixInputStream* gUnixInputStream, bool ownedRef = false)
76 	{
77 		this.gUnixInputStream = gUnixInputStream;
78 		super(cast(GInputStream*)gUnixInputStream, ownedRef);
79 	}
80 
81 	// add the FileDescriptorBased capabilities
82 	mixin FileDescriptorBasedT!(GUnixInputStream);
83 
84 	// add the PollableInputStream capabilities
85 	mixin PollableInputStreamT!(GUnixInputStream);
86 
87 
88 	/** */
89 	public static GType getType()
90 	{
91 		return g_unix_input_stream_get_type();
92 	}
93 
94 	/**
95 	 * Creates a new #GUnixInputStream for the given @fd.
96 	 *
97 	 * If @close_fd is %TRUE, the file descriptor will be closed
98 	 * when the stream is closed.
99 	 *
100 	 * Params:
101 	 *     fd = a UNIX file descriptor
102 	 *     closeFd = %TRUE to close the file descriptor when done
103 	 *
104 	 * Return: a new #GUnixInputStream
105 	 *
106 	 * Throws: ConstructionException GTK+ fails to create the object.
107 	 */
108 	public this(int fd, bool closeFd)
109 	{
110 		auto p = g_unix_input_stream_new(fd, closeFd);
111 		
112 		if(p is null)
113 		{
114 			throw new ConstructionException("null returned by new");
115 		}
116 		
117 		this(cast(GUnixInputStream*) p, true);
118 	}
119 
120 	/**
121 	 * Returns whether the file descriptor of @stream will be
122 	 * closed when the stream is closed.
123 	 *
124 	 * Return: %TRUE if the file descriptor is closed when done
125 	 *
126 	 * Since: 2.20
127 	 */
128 	public bool getCloseFd()
129 	{
130 		return g_unix_input_stream_get_close_fd(gUnixInputStream) != 0;
131 	}
132 
133 	/**
134 	 * Return the UNIX file descriptor that the stream reads from.
135 	 *
136 	 * Return: The file descriptor of @stream
137 	 *
138 	 * Since: 2.20
139 	 */
140 	public int getFd()
141 	{
142 		return g_unix_input_stream_get_fd(gUnixInputStream);
143 	}
144 
145 	/**
146 	 * Sets whether the file descriptor of @stream shall be closed
147 	 * when the stream is closed.
148 	 *
149 	 * Params:
150 	 *     closeFd = %TRUE to close the file descriptor when done
151 	 *
152 	 * Since: 2.20
153 	 */
154 	public void setCloseFd(bool closeFd)
155 	{
156 		g_unix_input_stream_set_close_fd(gUnixInputStream, closeFd);
157 	}
158 }