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