gio/auto/dbus_server.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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
// 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, Cancellable, DBusAuthObserver, DBusConnection, DBusServerFlags, Initable};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// `GDBusServer` is a helper for listening to and accepting D-Bus
/// connections. This can be used to create a new D-Bus server, allowing two
/// peers to use the D-Bus protocol for their own specialized communication.
/// A server instance provided in this way will not perform message routing or
/// implement the
/// [`org.freedesktop.DBus` interface](https://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-messages).
///
/// To just export an object on a well-known name on a message bus, such as the
/// session or system bus, you should instead use `bus_own_name()`.
///
/// An example of peer-to-peer communication with GDBus can be found
/// in [gdbus-example-peer.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-peer.c).
///
/// Note that a minimal `GDBusServer` will accept connections from any
/// peer. In many use-cases it will be necessary to add a
/// [`DBusAuthObserver`][crate::DBusAuthObserver] that only accepts connections that have
/// successfully authenticated as the same user that is running the
/// `GDBusServer`. Since GLib 2.68 this can be achieved more simply by passing
/// the `G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER` flag to the
/// server.
///
/// ## Properties
///
///
/// #### `active`
/// Whether the server is currently active.
///
/// Readable
///
///
/// #### `address`
/// The D-Bus address to listen on.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `authentication-observer`
/// A #GDBusAuthObserver object to assist in the authentication process or [`None`].
///
/// Readable | Writeable | Construct Only
///
///
/// #### `client-address`
/// The D-Bus address that clients can use.
///
/// Readable
///
///
/// #### `flags`
/// Flags from the #GDBusServerFlags enumeration.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `guid`
/// The GUID of the server.
///
/// See #GDBusConnection:guid for more details.
///
/// Readable | Writeable | Construct Only
///
/// ## Signals
///
///
/// #### `new-connection`
/// Emitted when a new authenticated connection has been made. Use
/// g_dbus_connection_get_peer_credentials() to figure out what
/// identity (if any), was authenticated.
///
/// If you want to accept the connection, take a reference to the
/// @connection object and return [`true`]. When you are done with the
/// connection call g_dbus_connection_close() and give up your
/// reference. Note that the other peer may disconnect at any time -
/// a typical thing to do when accepting a connection is to listen to
/// the #GDBusConnection::closed signal.
///
/// If #GDBusServer:flags contains [`DBusServerFlags::RUN_IN_THREAD`][crate::DBusServerFlags::RUN_IN_THREAD]
/// then the signal is emitted in a new thread dedicated to the
/// connection. Otherwise the signal is emitted in the
/// [thread-default main context][g-main-context-push-thread-default]
/// of the thread that @server was constructed in.
///
/// You are guaranteed that signal handlers for this signal runs
/// before incoming messages on @connection are processed. This means
/// that it's suitable to call g_dbus_connection_register_object() or
/// similar from the signal handler.
///
///
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`InitableExt`][trait@crate::prelude::InitableExt]
#[doc(alias = "GDBusServer")]
pub struct DBusServer(Object<ffi::GDBusServer>) @implements Initable;
match fn {
type_ => || ffi::g_dbus_server_get_type(),
}
}
impl DBusServer {
/// Creates a new D-Bus server that listens on the first address in
/// @address that works.
///
/// Once constructed, you can use g_dbus_server_get_client_address() to
/// get a D-Bus address string that clients can use to connect.
///
/// To have control over the available authentication mechanisms and
/// the users that are authorized to connect, it is strongly recommended
/// to provide a non-[`None`] #GDBusAuthObserver.
///
/// Connect to the #GDBusServer::new-connection signal to handle
/// incoming connections.
///
/// The returned #GDBusServer isn't active - you have to start it with
/// g_dbus_server_start().
///
/// #GDBusServer is used in this [example][gdbus-peer-to-peer].
///
/// This is a synchronous failable constructor. There is currently no
/// asynchronous version.
/// ## `address`
/// A D-Bus address.
/// ## `flags`
/// Flags from the #GDBusServerFlags enumeration.
/// ## `guid`
/// A D-Bus GUID.
/// ## `observer`
/// A #GDBusAuthObserver or [`None`].
/// ## `cancellable`
/// A #GCancellable or [`None`].
///
/// # Returns
///
/// A #GDBusServer or [`None`] if @error is set. Free with
/// g_object_unref().
#[doc(alias = "g_dbus_server_new_sync")]
pub fn new_sync(
address: &str,
flags: DBusServerFlags,
guid: &str,
observer: Option<&DBusAuthObserver>,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<DBusServer, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_dbus_server_new_sync(
address.to_glib_none().0,
flags.into_glib(),
guid.to_glib_none().0,
observer.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Gets a
/// [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses)
/// string that can be used by clients to connect to @self.
///
/// This is valid and non-empty if initializing the #GDBusServer succeeded.
///
/// # Returns
///
/// A D-Bus address string. Do not free, the string is owned
/// by @self.
#[doc(alias = "g_dbus_server_get_client_address")]
#[doc(alias = "get_client_address")]
#[doc(alias = "client-address")]
pub fn client_address(&self) -> glib::GString {
unsafe { from_glib_none(ffi::g_dbus_server_get_client_address(self.to_glib_none().0)) }
}
/// Gets the flags for @self.
///
/// # Returns
///
/// A set of flags from the #GDBusServerFlags enumeration.
#[doc(alias = "g_dbus_server_get_flags")]
#[doc(alias = "get_flags")]
pub fn flags(&self) -> DBusServerFlags {
unsafe { from_glib(ffi::g_dbus_server_get_flags(self.to_glib_none().0)) }
}
/// Gets the GUID for @self, as provided to g_dbus_server_new_sync().
///
/// # Returns
///
/// A D-Bus GUID. Do not free this string, it is owned by @self.
#[doc(alias = "g_dbus_server_get_guid")]
#[doc(alias = "get_guid")]
pub fn guid(&self) -> glib::GString {
unsafe { from_glib_none(ffi::g_dbus_server_get_guid(self.to_glib_none().0)) }
}
/// Gets whether @self is active.
///
/// # Returns
///
/// [`true`] if server is active, [`false`] otherwise.
#[doc(alias = "g_dbus_server_is_active")]
#[doc(alias = "active")]
pub fn is_active(&self) -> bool {
unsafe { from_glib(ffi::g_dbus_server_is_active(self.to_glib_none().0)) }
}
/// Starts @self.
#[doc(alias = "g_dbus_server_start")]
pub fn start(&self) {
unsafe {
ffi::g_dbus_server_start(self.to_glib_none().0);
}
}
/// Stops @self.
#[doc(alias = "g_dbus_server_stop")]
pub fn stop(&self) {
unsafe {
ffi::g_dbus_server_stop(self.to_glib_none().0);
}
}
/// The D-Bus address to listen on.
pub fn address(&self) -> Option<glib::GString> {
ObjectExt::property(self, "address")
}
/// A #GDBusAuthObserver object to assist in the authentication process or [`None`].
#[doc(alias = "authentication-observer")]
pub fn authentication_observer(&self) -> Option<DBusAuthObserver> {
ObjectExt::property(self, "authentication-observer")
}
/// Emitted when a new authenticated connection has been made. Use
/// g_dbus_connection_get_peer_credentials() to figure out what
/// identity (if any), was authenticated.
///
/// If you want to accept the connection, take a reference to the
/// @connection object and return [`true`]. When you are done with the
/// connection call g_dbus_connection_close() and give up your
/// reference. Note that the other peer may disconnect at any time -
/// a typical thing to do when accepting a connection is to listen to
/// the #GDBusConnection::closed signal.
///
/// If #GDBusServer:flags contains [`DBusServerFlags::RUN_IN_THREAD`][crate::DBusServerFlags::RUN_IN_THREAD]
/// then the signal is emitted in a new thread dedicated to the
/// connection. Otherwise the signal is emitted in the
/// [thread-default main context][g-main-context-push-thread-default]
/// of the thread that @server was constructed in.
///
/// You are guaranteed that signal handlers for this signal runs
/// before incoming messages on @connection are processed. This means
/// that it's suitable to call g_dbus_connection_register_object() or
/// similar from the signal handler.
/// ## `connection`
/// A #GDBusConnection for the new connection.
///
/// # Returns
///
/// [`true`] to claim @connection, [`false`] to let other handlers
/// run.
#[doc(alias = "new-connection")]
pub fn connect_new_connection<F: Fn(&Self, &DBusConnection) -> bool + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn new_connection_trampoline<
F: Fn(&DBusServer, &DBusConnection) -> bool + 'static,
>(
this: *mut ffi::GDBusServer,
connection: *mut ffi::GDBusConnection,
f: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), &from_glib_borrow(connection)).into_glib()
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"new-connection\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
new_connection_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "active")]
pub fn connect_active_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_active_trampoline<F: Fn(&DBusServer) + 'static>(
this: *mut ffi::GDBusServer,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::active\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_active_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "client-address")]
pub fn connect_client_address_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_client_address_trampoline<F: Fn(&DBusServer) + 'static>(
this: *mut ffi::GDBusServer,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::client-address\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_client_address_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}