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 	protected override void setStruct(GObject* obj)
65 	{
66 		gTcpWrapperConnection = cast(GTcpWrapperConnection*)obj;
67 		super.setStruct(obj);
68 	}
69 
70 	/**
71 	 * Sets our main struct and passes it to the parent class.
72 	 */
73 	public this (GTcpWrapperConnection* gTcpWrapperConnection, bool ownedRef = false)
74 	{
75 		this.gTcpWrapperConnection = gTcpWrapperConnection;
76 		super(cast(GTcpConnection*)gTcpWrapperConnection, ownedRef);
77 	}
78 
79 
80 	/** */
81 	public static GType getType()
82 	{
83 		return g_tcp_wrapper_connection_get_type();
84 	}
85 
86 	/**
87 	 * Wraps @base_io_stream and @socket together as a #GSocketConnection.
88 	 *
89 	 * Params:
90 	 *     baseIoStream = the #GIOStream to wrap
91 	 *     socket = the #GSocket associated with @base_io_stream
92 	 *
93 	 * Returns: the new #GSocketConnection.
94 	 *
95 	 * Since: 2.28
96 	 *
97 	 * Throws: ConstructionException GTK+ fails to create the object.
98 	 */
99 	public this(IOStream baseIoStream, Socket socket)
100 	{
101 		auto p = g_tcp_wrapper_connection_new((baseIoStream is null) ? null : baseIoStream.getIOStreamStruct(), (socket is null) ? null : socket.getSocketStruct());
102 
103 		if(p is null)
104 		{
105 			throw new ConstructionException("null returned by new");
106 		}
107 
108 		this(cast(GTcpWrapperConnection*) p, true);
109 	}
110 
111 	/**
112 	 * Get's @conn's base #GIOStream
113 	 *
114 	 * Returns: @conn's base #GIOStream
115 	 */
116 	public IOStream getBaseIoStream()
117 	{
118 		auto p = g_tcp_wrapper_connection_get_base_io_stream(gTcpWrapperConnection);
119 
120 		if(p is null)
121 		{
122 			return null;
123 		}
124 
125 		return ObjectG.getDObject!(IOStream)(cast(GIOStream*) p);
126 	}
127 }