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