gio.TcpConnection source code

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