File: ThreadedSocketService.d

package info (click to toggle)
gtk-d 3.10.0-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 20,144 kB
  • sloc: javascript: 565; sh: 71; makefile: 23
file content (134 lines) | stat: -rw-r--r-- 4,277 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module gio.ThreadedSocketService;

private import gio.SocketConnection;
private import gio.SocketService;
private import gio.c.functions;
public  import gio.c.types;
private import glib.ConstructionException;
private import gobject.ObjectG;
private import gobject.Signals;
public  import gtkc.giotypes;
private import std.algorithm;


/**
 * A #GThreadedSocketService is a simple subclass of #GSocketService
 * that handles incoming connections by creating a worker thread and
 * dispatching the connection to it by emitting the
 * #GThreadedSocketService::run signal in the new thread.
 * 
 * The signal handler may perform blocking IO and need not return
 * until the connection is closed.
 * 
 * The service is implemented using a thread pool, so there is a
 * limited amount of threads available to serve incoming requests.
 * The service automatically stops the #GSocketService from accepting
 * new connections when all threads are busy.
 * 
 * As with #GSocketService, you may connect to #GThreadedSocketService::run,
 * or subclass and override the default handler.
 *
 * Since: 2.22
 */
public class ThreadedSocketService : SocketService
{
	/** the main Gtk struct */
	protected GThreadedSocketService* gThreadedSocketService;

	/** Get the main Gtk struct */
	public GThreadedSocketService* getThreadedSocketServiceStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gThreadedSocketService;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gThreadedSocketService;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GThreadedSocketService* gThreadedSocketService, bool ownedRef = false)
	{
		this.gThreadedSocketService = gThreadedSocketService;
		super(cast(GSocketService*)gThreadedSocketService, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return g_threaded_socket_service_get_type();
	}

	/**
	 * Creates a new #GThreadedSocketService with no listeners. Listeners
	 * must be added with one of the #GSocketListener "add" methods.
	 *
	 * Params:
	 *     maxThreads = the maximal number of threads to execute concurrently
	 *         handling incoming clients, -1 means no limit
	 *
	 * Returns: a new #GSocketService.
	 *
	 * Since: 2.22
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(int maxThreads)
	{
		auto __p = g_threaded_socket_service_new(maxThreads);

		if(__p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GThreadedSocketService*) __p, true);
	}

	/**
	 * The ::run signal is emitted in a worker thread in response to an
	 * incoming connection. This thread is dedicated to handling
	 * @connection and may perform blocking IO. The signal handler need
	 * not return until the connection is closed.
	 *
	 * Params:
	 *     connection = a new #GSocketConnection object.
	 *     sourceObject = the source_object passed to g_socket_listener_add_address().
	 *
	 * Returns: %TRUE to stop further signal handlers from being called
	 */
	gulong addOnRun(bool delegate(SocketConnection, ObjectG, ThreadedSocketService) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		return Signals.connect(this, "run", dlg, connectFlags ^ ConnectFlags.SWAPPED);
	}
}