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.ThreadedSocketService;
26 
27 private import gio.SocketConnection;
28 private import gio.SocketService;
29 private import glib.ConstructionException;
30 private import gobject.ObjectG;
31 private import gobject.Signals;
32 private import gtkc.gio;
33 public  import gtkc.giotypes;
34 private import std.algorithm;
35 
36 
37 /**
38  * A #GThreadedSocketService is a simple subclass of #GSocketService
39  * that handles incoming connections by creating a worker thread and
40  * dispatching the connection to it by emitting the
41  * #GThreadedSocketService::run signal in the new thread.
42  * 
43  * The signal handler may perform blocking IO and need not return
44  * until the connection is closed.
45  * 
46  * The service is implemented using a thread pool, so there is a
47  * limited amount of threads available to serve incoming requests.
48  * The service automatically stops the #GSocketService from accepting
49  * new connections when all threads are busy.
50  * 
51  * As with #GSocketService, you may connect to #GThreadedSocketService::run,
52  * or subclass and override the default handler.
53  *
54  * Since: 2.22
55  */
56 public class ThreadedSocketService : SocketService
57 {
58 	/** the main Gtk struct */
59 	protected GThreadedSocketService* gThreadedSocketService;
60 
61 	/** Get the main Gtk struct */
62 	public GThreadedSocketService* getThreadedSocketServiceStruct(bool transferOwnership = false)
63 	{
64 		if (transferOwnership)
65 			ownedRef = false;
66 		return gThreadedSocketService;
67 	}
68 
69 	/** the main Gtk struct as a void* */
70 	protected override void* getStruct()
71 	{
72 		return cast(void*)gThreadedSocketService;
73 	}
74 
75 	protected override void setStruct(GObject* obj)
76 	{
77 		gThreadedSocketService = cast(GThreadedSocketService*)obj;
78 		super.setStruct(obj);
79 	}
80 
81 	/**
82 	 * Sets our main struct and passes it to the parent class.
83 	 */
84 	public this (GThreadedSocketService* gThreadedSocketService, bool ownedRef = false)
85 	{
86 		this.gThreadedSocketService = gThreadedSocketService;
87 		super(cast(GSocketService*)gThreadedSocketService, ownedRef);
88 	}
89 
90 
91 	/** */
92 	public static GType getType()
93 	{
94 		return g_threaded_socket_service_get_type();
95 	}
96 
97 	/**
98 	 * Creates a new #GThreadedSocketService with no listeners. Listeners
99 	 * must be added with one of the #GSocketListener "add" methods.
100 	 *
101 	 * Params:
102 	 *     maxThreads = the maximal number of threads to execute concurrently
103 	 *         handling incoming clients, -1 means no limit
104 	 *
105 	 * Returns: a new #GSocketService.
106 	 *
107 	 * Since: 2.22
108 	 *
109 	 * Throws: ConstructionException GTK+ fails to create the object.
110 	 */
111 	public this(int maxThreads)
112 	{
113 		auto p = g_threaded_socket_service_new(maxThreads);
114 		
115 		if(p is null)
116 		{
117 			throw new ConstructionException("null returned by new");
118 		}
119 		
120 		this(cast(GThreadedSocketService*) p, true);
121 	}
122 
123 	protected class OnRunDelegateWrapper
124 	{
125 		static OnRunDelegateWrapper[] listeners;
126 		bool delegate(SocketConnection, ObjectG, ThreadedSocketService) dlg;
127 		gulong handlerId;
128 		
129 		this(bool delegate(SocketConnection, ObjectG, ThreadedSocketService) dlg)
130 		{
131 			this.dlg = dlg;
132 			this.listeners ~= this;
133 		}
134 		
135 		void remove(OnRunDelegateWrapper source)
136 		{
137 			foreach(index, wrapper; listeners)
138 			{
139 				if (wrapper.handlerId == source.handlerId)
140 				{
141 					listeners[index] = null;
142 					listeners = std.algorithm.remove(listeners, index);
143 					break;
144 				}
145 			}
146 		}
147 	}
148 
149 	/**
150 	 * The ::run signal is emitted in a worker thread in response to an
151 	 * incoming connection. This thread is dedicated to handling
152 	 * @connection and may perform blocking IO. The signal handler need
153 	 * not return until the connection is closed.
154 	 *
155 	 * Params:
156 	 *     connection = a new #GSocketConnection object.
157 	 *     sourceObject = the source_object passed to g_socket_listener_add_address().
158 	 *
159 	 * Returns: %TRUE to stop further signal handlers from being called
160 	 */
161 	gulong addOnRun(bool delegate(SocketConnection, ObjectG, ThreadedSocketService) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
162 	{
163 		auto wrapper = new OnRunDelegateWrapper(dlg);
164 		wrapper.handlerId = Signals.connectData(
165 			this,
166 			"run",
167 			cast(GCallback)&callBackRun,
168 			cast(void*)wrapper,
169 			cast(GClosureNotify)&callBackRunDestroy,
170 			connectFlags);
171 		return wrapper.handlerId;
172 	}
173 	
174 	extern(C) static int callBackRun(GThreadedSocketService* threadedsocketserviceStruct, GSocketConnection* connection, GObject* sourceObject, OnRunDelegateWrapper wrapper)
175 	{
176 		return wrapper.dlg(ObjectG.getDObject!(SocketConnection)(connection), ObjectG.getDObject!(ObjectG)(sourceObject), wrapper.outer);
177 	}
178 	
179 	extern(C) static void callBackRunDestroy(OnRunDelegateWrapper wrapper, GClosure* closure)
180 	{
181 		wrapper.remove(wrapper);
182 	}
183 }