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  * Conversion parameters:
26  * inFile  = GTcpConnection.html
27  * outPack = gio
28  * outFile = TcpConnection
29  * strct   = GTcpConnection
30  * realStrct=
31  * ctorStrct=
32  * clss    = TcpConnection
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- g_tcp_connection_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * structWrap:
47  * module aliases:
48  * local aliases:
49  * overrides:
50  */
51 
52 module gio.TcpConnection;
53 
54 public  import gtkc.giotypes;
55 
56 private import gtkc.gio;
57 private import glib.ConstructionException;
58 private import gobject.ObjectG;
59 
60 
61 
62 private import gio.SocketConnection;
63 
64 /**
65  * This is the subclass of GSocketConnection that is created
66  * for TCP/IP sockets.
67  */
68 public class TcpConnection : SocketConnection
69 {
70 	
71 	/** the main Gtk struct */
72 	protected GTcpConnection* gTcpConnection;
73 	
74 	
75 	/** Get the main Gtk struct */
76 	public GTcpConnection* getTcpConnectionStruct()
77 	{
78 		return gTcpConnection;
79 	}
80 	
81 	
82 	/** the main Gtk struct as a void* */
83 	protected override void* getStruct()
84 	{
85 		return cast(void*)gTcpConnection;
86 	}
87 	
88 	/**
89 	 * Sets our main struct and passes it to the parent class
90 	 */
91 	public this (GTcpConnection* gTcpConnection)
92 	{
93 		super(cast(GSocketConnection*)gTcpConnection);
94 		this.gTcpConnection = gTcpConnection;
95 	}
96 	
97 	protected override void setStruct(GObject* obj)
98 	{
99 		super.setStruct(obj);
100 		gTcpConnection = cast(GTcpConnection*)obj;
101 	}
102 	
103 	/**
104 	 */
105 	
106 	/**
107 	 * This enabled graceful disconnects on close. A graceful disconnect
108 	 * means that we signal the receiving end that the connection is terminated
109 	 * and wait for it to close the connection before closing the connection.
110 	 * A graceful disconnect means that we can be sure that we successfully sent
111 	 * all the outstanding data to the other end, or get an error reported.
112 	 * However, it also means we have to wait for all the data to reach the
113 	 * other side and for it to acknowledge this by closing the socket, which may
114 	 * take a while. For this reason it is disabled by default.
115 	 * Since 2.22
116 	 * Params:
117 	 * gracefulDisconnect = Whether to do graceful disconnects or not
118 	 */
119 	public void setGracefulDisconnect(int gracefulDisconnect)
120 	{
121 		// void g_tcp_connection_set_graceful_disconnect  (GTcpConnection *connection,  gboolean graceful_disconnect);
122 		g_tcp_connection_set_graceful_disconnect(gTcpConnection, gracefulDisconnect);
123 	}
124 	
125 	/**
126 	 * Checks if graceful disconnects are used. See
127 	 * g_tcp_connection_set_graceful_disconnect().
128 	 * Since 2.22
129 	 * Returns: TRUE if graceful disconnect is used on close, FALSE otherwise
130 	 */
131 	public int getGracefulDisconnect()
132 	{
133 		// gboolean g_tcp_connection_get_graceful_disconnect  (GTcpConnection *connection);
134 		return g_tcp_connection_get_graceful_disconnect(gTcpConnection);
135 	}
136 }