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 gio.c.functions; 33 public import gio.c.types; 34 private import glib.ConstructionException; 35 private import gobject.ObjectG; 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(bool transferOwnership = false) 56 { 57 if (transferOwnership) 58 ownedRef = false; 59 return gUnixInputStream; 60 } 61 62 /** the main Gtk struct as a void* */ 63 protected override void* getStruct() 64 { 65 return cast(void*)gUnixInputStream; 66 } 67 68 /** 69 * Sets our main struct and passes it to the parent class. 70 */ 71 public this (GUnixInputStream* gUnixInputStream, bool ownedRef = false) 72 { 73 this.gUnixInputStream = gUnixInputStream; 74 super(cast(GInputStream*)gUnixInputStream, ownedRef); 75 } 76 77 // add the FileDescriptorBased capabilities 78 mixin FileDescriptorBasedT!(GUnixInputStream); 79 80 // add the PollableInputStream capabilities 81 mixin PollableInputStreamT!(GUnixInputStream); 82 83 84 /** */ 85 public static GType getType() 86 { 87 return g_unix_input_stream_get_type(); 88 } 89 90 /** 91 * Creates a new #GUnixInputStream for the given @fd. 92 * 93 * If @close_fd is %TRUE, the file descriptor will be closed 94 * when the stream is closed. 95 * 96 * Params: 97 * fd = a UNIX file descriptor 98 * closeFd = %TRUE to close the file descriptor when done 99 * 100 * Returns: a new #GUnixInputStream 101 * 102 * Throws: ConstructionException GTK+ fails to create the object. 103 */ 104 public this(int fd, bool closeFd) 105 { 106 auto __p = g_unix_input_stream_new(fd, closeFd); 107 108 if(__p is null) 109 { 110 throw new ConstructionException("null returned by new"); 111 } 112 113 this(cast(GUnixInputStream*) __p, true); 114 } 115 116 /** 117 * Returns whether the file descriptor of @stream will be 118 * closed when the stream is closed. 119 * 120 * Returns: %TRUE if the file descriptor is closed when done 121 * 122 * Since: 2.20 123 */ 124 public bool getCloseFd() 125 { 126 return g_unix_input_stream_get_close_fd(gUnixInputStream) != 0; 127 } 128 129 /** 130 * Return the UNIX file descriptor that the stream reads from. 131 * 132 * Returns: The file descriptor of @stream 133 * 134 * Since: 2.20 135 */ 136 public int getFd() 137 { 138 return g_unix_input_stream_get_fd(gUnixInputStream); 139 } 140 141 /** 142 * Sets whether the file descriptor of @stream shall be closed 143 * when the stream is closed. 144 * 145 * Params: 146 * closeFd = %TRUE to close the file descriptor when done 147 * 148 * Since: 2.20 149 */ 150 public void setCloseFd(bool closeFd) 151 { 152 g_unix_input_stream_set_close_fd(gUnixInputStream, closeFd); 153 } 154 }