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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
// 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::AsyncResult;
use crate::Cancellable;
use crate::Initable;
use crate::NetworkConnectivity;
use crate::SocketConnectable;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use std::pin::Pin;
use std::ptr;
glib::wrapper! {
/// [`NetworkMonitor`][crate::NetworkMonitor] provides an easy-to-use cross-platform API
/// for monitoring network connectivity. On Linux, the available
/// implementations are based on the kernel's netlink interface and
/// on NetworkManager.
///
/// There is also an implementation for use inside Flatpak sandboxes.
///
/// # Implements
///
/// [`NetworkMonitorExt`][trait@crate::prelude::NetworkMonitorExt], [`InitableExt`][trait@crate::prelude::InitableExt]
#[doc(alias = "GNetworkMonitor")]
pub struct NetworkMonitor(Interface<ffi::GNetworkMonitor, ffi::GNetworkMonitorInterface>) @requires Initable;
match fn {
type_ => || ffi::g_network_monitor_get_type(),
}
}
impl NetworkMonitor {
pub const NONE: Option<&'static NetworkMonitor> = None;
/// Gets the default [`NetworkMonitor`][crate::NetworkMonitor] for the system.
///
/// # Returns
///
/// a [`NetworkMonitor`][crate::NetworkMonitor], which will be
/// a dummy object if no network monitor is available
#[doc(alias = "g_network_monitor_get_default")]
#[doc(alias = "get_default")]
#[allow(clippy::should_implement_trait)]
pub fn default() -> NetworkMonitor {
unsafe { from_glib_none(ffi::g_network_monitor_get_default()) }
}
}
/// Trait containing all [`struct@NetworkMonitor`] methods.
///
/// # Implementors
///
/// [`NetworkMonitor`][struct@crate::NetworkMonitor]
pub trait NetworkMonitorExt: 'static {
/// Attempts to determine whether or not the host pointed to by
/// `connectable` can be reached, without actually trying to connect to
/// it.
///
/// This may return [`true`] even when `property::NetworkMonitor::network-available`
/// is [`false`], if, for example, `self` can determine that
/// `connectable` refers to a host on a local network.
///
/// If `self` believes that an attempt to connect to `connectable`
/// will succeed, it will return [`true`]. Otherwise, it will return
/// [`false`] and set `error` to an appropriate error (such as
/// [`IOErrorEnum::HostUnreachable`][crate::IOErrorEnum::HostUnreachable]).
///
/// Note that although this does not attempt to connect to
/// `connectable`, it may still block for a brief period of time (eg,
/// trying to do multicast DNS on the local network), so if you do not
/// want to block, you should use [`can_reach_async()`][Self::can_reach_async()].
/// ## `connectable`
/// a [`SocketConnectable`][crate::SocketConnectable]
/// ## `cancellable`
/// a [`Cancellable`][crate::Cancellable], or [`None`]
///
/// # Returns
///
/// [`true`] if `connectable` is reachable, [`false`] if not.
#[doc(alias = "g_network_monitor_can_reach")]
fn can_reach(
&self,
connectable: &impl IsA<SocketConnectable>,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error>;
/// Asynchronously attempts to determine whether or not the host
/// pointed to by `connectable` can be reached, without actually
/// trying to connect to it.
///
/// For more details, see [`can_reach()`][Self::can_reach()].
///
/// When the operation is finished, `callback` will be called.
/// You can then call `g_network_monitor_can_reach_finish()`
/// to get the result of the operation.
/// ## `connectable`
/// a [`SocketConnectable`][crate::SocketConnectable]
/// ## `cancellable`
/// a [`Cancellable`][crate::Cancellable], or [`None`]
/// ## `callback`
/// a `GAsyncReadyCallback` to call when the
/// request is satisfied
#[doc(alias = "g_network_monitor_can_reach_async")]
fn can_reach_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
connectable: &impl IsA<SocketConnectable>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
);
fn can_reach_future(
&self,
connectable: &(impl IsA<SocketConnectable> + Clone + 'static),
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>>;
/// Gets a more detailed networking state than
/// [`is_network_available()`][Self::is_network_available()].
///
/// If `property::NetworkMonitor::network-available` is [`false`], then the
/// connectivity state will be [`NetworkConnectivity::Local`][crate::NetworkConnectivity::Local].
///
/// If `property::NetworkMonitor::network-available` is [`true`], then the
/// connectivity state will be [`NetworkConnectivity::Full`][crate::NetworkConnectivity::Full] (if there
/// is full Internet connectivity), [`NetworkConnectivity::Limited`][crate::NetworkConnectivity::Limited] (if
/// the host has a default route, but appears to be unable to actually
/// reach the full Internet), or [`NetworkConnectivity::Portal`][crate::NetworkConnectivity::Portal] (if the
/// host is trapped behind a "captive portal" that requires some sort
/// of login or acknowledgement before allowing full Internet access).
///
/// Note that in the case of [`NetworkConnectivity::Limited`][crate::NetworkConnectivity::Limited] and
/// [`NetworkConnectivity::Portal`][crate::NetworkConnectivity::Portal], it is possible that some sites are
/// reachable but others are not. In this case, applications can
/// attempt to connect to remote servers, but should gracefully fall
/// back to their "offline" behavior if the connection attempt fails.
///
/// # Returns
///
/// the network connectivity state
#[doc(alias = "g_network_monitor_get_connectivity")]
#[doc(alias = "get_connectivity")]
fn connectivity(&self) -> NetworkConnectivity;
/// Checks if the network is available. "Available" here means that the
/// system has a default route available for at least one of IPv4 or
/// IPv6. It does not necessarily imply that the public Internet is
/// reachable. See `property::NetworkMonitor::network-available` for more details.
///
/// # Returns
///
/// whether the network is available
#[doc(alias = "g_network_monitor_get_network_available")]
#[doc(alias = "get_network_available")]
fn is_network_available(&self) -> bool;
/// Checks if the network is metered.
/// See `property::NetworkMonitor::network-metered` for more details.
///
/// # Returns
///
/// whether the connection is metered
#[doc(alias = "g_network_monitor_get_network_metered")]
#[doc(alias = "get_network_metered")]
fn is_network_metered(&self) -> bool;
/// Emitted when the network configuration changes.
/// ## `network_available`
/// the current value of `property::NetworkMonitor::network-available`
#[doc(alias = "network-changed")]
fn connect_network_changed<F: Fn(&Self, bool) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "connectivity")]
fn connect_connectivity_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "network-available")]
fn connect_network_available_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "network-metered")]
fn connect_network_metered_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<NetworkMonitor>> NetworkMonitorExt for O {
fn can_reach(
&self,
connectable: &impl IsA<SocketConnectable>,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::g_network_monitor_can_reach(
self.as_ref().to_glib_none().0,
connectable.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
fn can_reach_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
connectable: &impl IsA<SocketConnectable>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn can_reach_async_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let _ =
ffi::g_network_monitor_can_reach_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = can_reach_async_trampoline::<P>;
unsafe {
ffi::g_network_monitor_can_reach_async(
self.as_ref().to_glib_none().0,
connectable.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn can_reach_future(
&self,
connectable: &(impl IsA<SocketConnectable> + Clone + 'static),
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let connectable = connectable.clone();
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.can_reach_async(&connectable, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
fn connectivity(&self) -> NetworkConnectivity {
unsafe {
from_glib(ffi::g_network_monitor_get_connectivity(
self.as_ref().to_glib_none().0,
))
}
}
fn is_network_available(&self) -> bool {
unsafe {
from_glib(ffi::g_network_monitor_get_network_available(
self.as_ref().to_glib_none().0,
))
}
}
fn is_network_metered(&self) -> bool {
unsafe {
from_glib(ffi::g_network_monitor_get_network_metered(
self.as_ref().to_glib_none().0,
))
}
}
fn connect_network_changed<F: Fn(&Self, bool) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn network_changed_trampoline<
P: IsA<NetworkMonitor>,
F: Fn(&P, bool) + 'static,
>(
this: *mut ffi::GNetworkMonitor,
network_available: glib::ffi::gboolean,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
NetworkMonitor::from_glib_borrow(this).unsafe_cast_ref(),
from_glib(network_available),
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"network-changed\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
network_changed_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_connectivity_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_connectivity_trampoline<
P: IsA<NetworkMonitor>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GNetworkMonitor,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(NetworkMonitor::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::connectivity\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_connectivity_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_network_available_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_network_available_trampoline<
P: IsA<NetworkMonitor>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GNetworkMonitor,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(NetworkMonitor::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::network-available\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_network_available_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_network_metered_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_network_metered_trampoline<
P: IsA<NetworkMonitor>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GNetworkMonitor,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(NetworkMonitor::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::network-metered\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_network_metered_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for NetworkMonitor {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("NetworkMonitor")
}
}