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.TcpConnection; 26 27 private import gio.SocketConnection; 28 private import gio.c.functions; 29 public import gio.c.types; 30 31 32 /** 33 * This is the subclass of #GSocketConnection that is created 34 * for TCP/IP sockets. 35 * 36 * Since: 2.22 37 */ 38 public class TcpConnection : SocketConnection 39 { 40 /** the main Gtk struct */ 41 protected GTcpConnection* gTcpConnection; 42 43 /** Get the main Gtk struct */ 44 public GTcpConnection* getTcpConnectionStruct(bool transferOwnership = false) 45 { 46 if (transferOwnership) 47 ownedRef = false; 48 return gTcpConnection; 49 } 50 51 /** the main Gtk struct as a void* */ 52 protected override void* getStruct() 53 { 54 return cast(void*)gTcpConnection; 55 } 56 57 /** 58 * Sets our main struct and passes it to the parent class. 59 */ 60 public this (GTcpConnection* gTcpConnection, bool ownedRef = false) 61 { 62 this.gTcpConnection = gTcpConnection; 63 super(cast(GSocketConnection*)gTcpConnection, ownedRef); 64 } 65 66 67 /** */ 68 public static GType getType() 69 { 70 return g_tcp_connection_get_type(); 71 } 72 73 /** 74 * Checks if graceful disconnects are used. See 75 * g_tcp_connection_set_graceful_disconnect(). 76 * 77 * Returns: %TRUE if graceful disconnect is used on close, %FALSE otherwise 78 * 79 * Since: 2.22 80 */ 81 public bool getGracefulDisconnect() 82 { 83 return g_tcp_connection_get_graceful_disconnect(gTcpConnection) != 0; 84 } 85 86 /** 87 * This enables graceful disconnects on close. A graceful disconnect 88 * means that we signal the receiving end that the connection is terminated 89 * and wait for it to close the connection before closing the connection. 90 * 91 * A graceful disconnect means that we can be sure that we successfully sent 92 * all the outstanding data to the other end, or get an error reported. 93 * However, it also means we have to wait for all the data to reach the 94 * other side and for it to acknowledge this by closing the socket, which may 95 * take a while. For this reason it is disabled by default. 96 * 97 * Params: 98 * gracefulDisconnect = Whether to do graceful disconnects or not 99 * 100 * Since: 2.22 101 */ 102 public void setGracefulDisconnect(bool gracefulDisconnect) 103 { 104 g_tcp_connection_set_graceful_disconnect(gTcpConnection, gracefulDisconnect); 105 } 106 }