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