gio.TcpWrapperConnection 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.TcpWrapperConnection;
26 
27 private import gio.IOStream;
28 private import gio.Socket;
29 private import gio.SocketConnection;
30 private import gio.TcpConnection;
31 private import gio.c.functions;
32 public  import gio.c.types;
33 private import glib.ConstructionException;
34 private import gobject.ObjectG;
35 
36 
37 /**
38  * A #GTcpWrapperConnection can be used to wrap a #GIOStream that is
39  * based on a #GSocket, but which is not actually a
40  * #GSocketConnection. This is used by #GSocketClient so that it can
41  * always return a #GSocketConnection, even when the connection it has
42  * actually created is not directly a #GSocketConnection.
43  *
44  * Since: 2.28
45  */
46 public class TcpWrapperConnection : TcpConnection
47 {
48 	/** the main Gtk struct */
49 	protected GTcpWrapperConnection* gTcpWrapperConnection;
50 
51 	/** Get the main Gtk struct */
52 	public GTcpWrapperConnection* getTcpWrapperConnectionStruct(bool transferOwnership = false)
53 	{
54 		if (transferOwnership)
55 			ownedRef = false;
56 		return gTcpWrapperConnection;
57 	}
58 
59 	/** the main Gtk struct as a void* */
60 	protected override void* getStruct()
61 	{
62 		return cast(void*)gTcpWrapperConnection;
63 	}
64 
65 	/**
66 	 * Sets our main struct and passes it to the parent class.
67 	 */
68 	public this (GTcpWrapperConnection* gTcpWrapperConnection, bool ownedRef = false)
69 	{
70 		this.gTcpWrapperConnection = gTcpWrapperConnection;
71 		super(cast(GTcpConnection*)gTcpWrapperConnection, ownedRef);
72 	}
73 
74 
75 	/** */
76 	public static GType getType()
77 	{
78 		return g_tcp_wrapper_connection_get_type();
79 	}
80 
81 	/**
82 	 * Wraps @base_io_stream and @socket together as a #GSocketConnection.
83 	 *
84 	 * Params:
85 	 *     baseIoStream = the #GIOStream to wrap
86 	 *     socket = the #GSocket associated with @base_io_stream
87 	 *
88 	 * Returns: the new #GSocketConnection.
89 	 *
90 	 * Since: 2.28
91 	 *
92 	 * Throws: ConstructionException GTK+ fails to create the object.
93 	 */
94 	public this(IOStream baseIoStream, Socket socket)
95 	{
96 		auto __p = g_tcp_wrapper_connection_new((baseIoStream is null) ? null : baseIoStream.getIOStreamStruct(), (socket is null) ? null : socket.getSocketStruct());
97 
98 		if(__p is null)
99 		{
100 			throw new ConstructionException("null returned by new");
101 		}
102 
103 		this(cast(GTcpWrapperConnection*) __p, true);
104 	}
105 
106 	/**
107 	 * Gets @conn's base #GIOStream
108 	 *
109 	 * Returns: @conn's base #GIOStream
110 	 */
111 	public IOStream getBaseIoStream()
112 	{
113 		auto __p = g_tcp_wrapper_connection_get_base_io_stream(gTcpWrapperConnection);
114 
115 		if(__p is null)
116 		{
117 			return null;
118 		}
119 
120 		return ObjectG.getDObject!(IOStream)(cast(GIOStream*) __p);
121 	}
122 }