gio/auto/
threaded_socket_service.rs

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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, SocketConnection, SocketListener, SocketService};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A `GThreadedSocketService` is a simple subclass of [`SocketService`][crate::SocketService]
    /// that handles incoming connections by creating a worker thread and
    /// dispatching the connection to it by emitting the
    /// [`run`][struct@crate::ThreadedSocketService#run] signal] in the new thread.
    ///
    /// The signal handler may perform blocking I/O 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 [`SocketService`][crate::SocketService] from accepting
    /// new connections when all threads are busy.
    ///
    /// As with [`SocketService`][crate::SocketService], you may connect to
    /// [`run`][struct@crate::ThreadedSocketService#run], or subclass and override the default
    /// handler.
    ///
    /// ## Properties
    ///
    ///
    /// #### `max-threads`
    ///  The maximum number of threads handling clients for this service.
    ///
    /// Readable | Writeable | Construct Only
    /// <details><summary><h4>SocketService</h4></summary>
    ///
    ///
    /// #### `active`
    ///  Whether the service is currently accepting connections.
    ///
    /// Readable | Writeable | Construct
    /// </details>
    /// <details><summary><h4>SocketListener</h4></summary>
    ///
    ///
    /// #### `listen-backlog`
    ///  The number of outstanding connections in the listen queue.
    ///
    /// Readable | Writeable | Construct
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `run`
    ///  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.
    ///
    ///
    /// <details><summary><h4>SocketService</h4></summary>
    ///
    ///
    /// #### `incoming`
    ///  The ::incoming signal is emitted when a new incoming connection
    /// to @service needs to be handled. The handler must initiate the
    /// handling of @connection, but may not block; in essence,
    /// asynchronous operations must be used.
    ///
    /// @connection will be unreffed once the signal handler returns,
    /// so you need to ref it yourself if you are planning to use it.
    ///
    ///
    /// </details>
    /// <details><summary><h4>SocketListener</h4></summary>
    ///
    ///
    /// #### `event`
    ///  Emitted when @listener's activity on @socket changes state.
    /// Note that when @listener is used to listen on both IPv4 and
    /// IPv6, a separate set of signals will be emitted for each, and
    /// the order they happen in is undefined.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`ThreadedSocketServiceExt`][trait@crate::prelude::ThreadedSocketServiceExt], [`SocketServiceExt`][trait@crate::prelude::SocketServiceExt], [`SocketListenerExt`][trait@crate::prelude::SocketListenerExt], [`trait@glib::ObjectExt`], [`SocketListenerExtManual`][trait@crate::prelude::SocketListenerExtManual]
    #[doc(alias = "GThreadedSocketService")]
    pub struct ThreadedSocketService(Object<ffi::GThreadedSocketService, ffi::GThreadedSocketServiceClass>) @extends SocketService, SocketListener;

    match fn {
        type_ => || ffi::g_threaded_socket_service_get_type(),
    }
}

impl ThreadedSocketService {
    pub const NONE: Option<&'static ThreadedSocketService> = None;
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::ThreadedSocketService>> Sealed for T {}
}

/// Trait containing all [`struct@ThreadedSocketService`] methods.
///
/// # Implementors
///
/// [`ThreadedSocketService`][struct@crate::ThreadedSocketService]
pub trait ThreadedSocketServiceExt: IsA<ThreadedSocketService> + sealed::Sealed + 'static {
    /// The maximum number of threads handling clients for this service.
    #[doc(alias = "max-threads")]
    fn max_threads(&self) -> i32 {
        ObjectExt::property(self.as_ref(), "max-threads")
    }

    /// 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.
    /// ## `connection`
    /// a new #GSocketConnection object.
    /// ## `source_object`
    /// the source_object passed to g_socket_listener_add_address().
    ///
    /// # Returns
    ///
    /// [`true`] to stop further signal handlers from being called
    #[doc(alias = "run")]
    fn connect_run<F: Fn(&Self, &SocketConnection, Option<&glib::Object>) -> bool + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn run_trampoline<
            P: IsA<ThreadedSocketService>,
            F: Fn(&P, &SocketConnection, Option<&glib::Object>) -> bool + 'static,
        >(
            this: *mut ffi::GThreadedSocketService,
            connection: *mut ffi::GSocketConnection,
            source_object: *mut glib::gobject_ffi::GObject,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let f: &F = &*(f as *const F);
            f(
                ThreadedSocketService::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(connection),
                Option::<glib::Object>::from_glib_borrow(source_object)
                    .as_ref()
                    .as_ref(),
            )
            .into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"run\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    run_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<ThreadedSocketService>> ThreadedSocketServiceExt for O {}