nm_rs/auto/

device_wimax.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir
// from gtk-girs (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
#![allow(deprecated)]

use crate::{ffi,Device,Object,WimaxNsp};
use glib::{prelude::*,signal::{connect_raw, SignalHandlerId},translate::*};
use std::{boxed::Box as Box_};

glib::wrapper! {
    /// WiMAX is no longer supported by NetworkManager since 1.2.0.
    ///
    ///
    /// ## Properties
    ///
    ///
    /// #### `active-nsp`
    ///  The active #NMWimaxNsp of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `bsid`
    ///  The ID of the serving base station as received from the network.  Has
    /// no meaning when the device is not connected.
    ///
    /// Readable
    ///
    ///
    /// #### `center-frequency`
    ///  The center frequency (in KHz) of the radio channel the device is using to
    /// communicate with the network when connected.  Has no meaning when the
    /// device is not connected.
    ///
    /// Readable
    ///
    ///
    /// #### `cinr`
    ///  CINR (Carrier to Interference + Noise Ratio) of the current radio link
    /// in dB.  CINR is a more accurate measure of radio link quality.  Has no
    /// meaning when the device is not connected.
    ///
    /// Readable
    ///
    ///
    /// #### `hw-address`
    ///  The hardware (MAC) address of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `nsps`
    ///  List of all WiMAX Network Service Providers the device can see.
    ///
    /// Readable
    ///
    ///
    /// #### `rssi`
    ///  RSSI of the current radio link in dBm.  This value indicates how strong
    /// the raw received RF signal from the base station is, but does not
    /// indicate the overall quality of the radio link.  Has no meaning when the
    /// device is not connected.
    ///
    /// Readable
    ///
    ///
    /// #### `tx-power`
    ///  Average power of the last burst transmitted by the device, in units of
    /// 0.5 dBm.  i.e. a TxPower of -11 represents an actual device TX power of
    /// -5.5 dBm.  Has no meaning when the device is not connected.
    ///
    /// Readable
    /// <details><summary><h4>Device</h4></summary>
    ///
    ///
    /// #### `active-connection`
    ///  The #NMActiveConnection object that "owns" this device during activation.
    ///
    /// Readable
    ///
    ///
    /// #### `autoconnect`
    ///  Whether the device can auto-activate a connection.
    ///
    /// The property setter is a synchronous D-Bus call. This is deprecated since 1.22.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `available-connections`
    ///  The available connections of the device
    ///
    /// Readable
    ///
    ///
    /// #### `capabilities`
    ///  The capabilities of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `device-type`
    ///  The numeric type of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `dhcp4-config`
    ///  The IPv4 #NMDhcpConfig of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `dhcp6-config`
    ///  The IPv6 #NMDhcpConfig of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `driver`
    ///  The driver of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `driver-version`
    ///  The version of the device driver.
    ///
    /// Readable
    ///
    ///
    /// #### `firmware-missing`
    ///  When [`true`] indicates the device is likely missing firmware required
    /// for its operation.
    ///
    /// Readable
    ///
    ///
    /// #### `firmware-version`
    ///  The firmware version of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `hw-address`
    ///  The hardware address of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `interface`
    ///  The interface of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `interface-flags`
    ///  The interface flags.
    ///
    /// Readable
    ///
    ///
    /// #### `ip-interface`
    ///  The IP interface of the device which should be used for all IP-related
    /// operations like addressing and routing.
    ///
    /// Readable
    ///
    ///
    /// #### `ip4-config`
    ///  The #NMIP4Config of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `ip4-connectivity`
    ///  The IPv4 connectivity state of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `ip6-config`
    ///  The IPv6 #NMIPConfig of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `ip6-connectivity`
    ///  The IPv6 connectivity state of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `lldp-neighbors`
    ///  The LLDP neighbors.
    ///
    /// Readable
    ///
    ///
    /// #### `managed`
    ///  Whether the device is managed by NetworkManager.
    ///
    /// Readable
    ///
    ///
    /// #### `metered`
    ///  Whether the device is metered.
    ///
    /// Readable
    ///
    ///
    /// #### `mtu`
    ///  The MTU of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `nm-plugin-missing`
    ///  When [`true`] indicates that the NetworkManager plugin for the device
    /// is not installed.
    ///
    /// Readable
    ///
    ///
    /// #### `path`
    ///  The device path as exposed by the udev property ID_PATH.
    ///
    /// The string is backslash escaped (C escaping) for invalid
    /// characters. The escaping can be reverted with g_strcompress(),
    /// however the result may not be valid UTF-8.
    ///
    /// Readable
    ///
    ///
    /// #### `physical-port-id`
    ///  The physical port ID of the device. (See
    /// nm_device_get_physical_port_id().)
    ///
    /// Readable
    ///
    ///
    /// #### `ports`
    ///  The port devices of the controller device. For devices that cannot be
    /// controllers this is likely to be always empty.
    ///
    /// Readable
    ///
    ///
    /// #### `product`
    ///  The product string of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `real`
    ///  Whether the device is real or is a placeholder device that could
    /// be created automatically by NetworkManager if one of its
    /// #NMDevice:available-connections was activated.
    ///
    /// Readable
    ///
    ///
    /// #### `state`
    ///  The state of the device.
    ///
    /// Readable
    ///
    ///
    /// #### `state-reason`
    ///  The reason for the device state.
    ///
    /// Readable
    ///
    ///
    /// #### `udi`
    ///  An operating-system specific device hardware identifier; this is not
    /// unique to a specific hardware device across reboots or hotplugs.  It
    /// is an opaque string which for some device types (Bluetooth, Modem)
    /// contains an identifier provided by the underlying hardware service daemon
    /// such as Bluez or ModemManager, and clients can use this property to
    /// request more information about the device from those services.
    ///
    /// Readable
    ///
    ///
    /// #### `vendor`
    ///  The vendor string of the device.
    ///
    /// Readable
    /// </details>
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `client`
    ///  The NMClient instance as returned by nm_object_get_client().
    ///
    /// When an NMObject gets removed from the NMClient cache,
    /// the NMObject:path property stays unchanged, but this client
    /// instance gets reset to [`None`]. You can use this property to
    /// track removal of the object from the cache.
    ///
    /// Readable
    ///
    ///
    /// #### `path`
    ///  The D-Bus object path.
    ///
    /// The D-Bus path of an object instance never changes, even if the object
    /// gets removed from the cache. To see whether the object is still in the
    /// cache, check NMObject:client.
    ///
    /// Readable
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `nsp-added`
    ///  Notifies that a #NMWimaxNsp is added to the wimax device.
    ///
    ///
    ///
    ///
    /// #### `nsp-removed`
    ///  Notifies that a #NMWimaxNsp is removed from the wimax device.
    ///
    ///
    /// <details><summary><h4>Device</h4></summary>
    ///
    ///
    /// #### `state-changed`
    ///  Notifies the state change of a #NMDevice.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`DeviceExt`][trait@crate::prelude::DeviceExt], [`ObjectExt`][trait@crate::prelude::ObjectExt]
    #[doc(alias = "NMDeviceWimax")]
    pub struct DeviceWimax(Object<ffi::NMDeviceWimax, ffi::NMDeviceWimaxClass>) @extends Device, Object;

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

impl DeviceWimax {
            // rustdoc-stripper-ignore-next
            /// Creates a new builder-pattern struct instance to construct [`DeviceWimax`] objects.
            ///
            /// This method returns an instance of [`DeviceWimaxBuilder`](crate::builders::DeviceWimaxBuilder) which can be used to create [`DeviceWimax`] objects.
            pub fn builder() -> DeviceWimaxBuilder {
                DeviceWimaxBuilder::new()
            }
        

    /// Gets the active #NMWimaxNsp.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the access point or [`None`] if none is active
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_active_nsp")]
    #[doc(alias = "get_active_nsp")]
    #[doc(alias = "active-nsp")]
    pub fn active_nsp(&self) -> WimaxNsp {
        unsafe {
            from_glib_full(ffi::nm_device_wimax_get_active_nsp(self.to_glib_none().0))
        }
    }

    /// Gets the ID of the serving Base Station when the device is connected.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the ID of the serving Base Station, or [`None`]
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_bsid")]
    #[doc(alias = "get_bsid")]
    pub fn bsid(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_device_wimax_get_bsid(self.to_glib_none().0))
        }
    }

    /// Gets the center frequency (in KHz) of the radio channel the device is using
    /// to communicate with the network when connected.  Has no meaning when the
    /// device is not connected.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the center frequency in KHz, or 0
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_center_frequency")]
    #[doc(alias = "get_center_frequency")]
    #[doc(alias = "center-frequency")]
    pub fn center_frequency(&self) -> u32 {
        unsafe {
            ffi::nm_device_wimax_get_center_frequency(self.to_glib_none().0)
        }
    }

    /// Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio
    /// link in dB.  CINR is a more accurate measure of radio link quality.  Has no
    /// meaning when the device is not connected.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the CINR in dB, or 0
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_cinr")]
    #[doc(alias = "get_cinr")]
    pub fn cinr(&self) -> i32 {
        unsafe {
            ffi::nm_device_wimax_get_cinr(self.to_glib_none().0)
        }
    }

    /// Gets the hardware (MAC) address of the #NMDeviceWimax
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the hardware address. This is the internal string used by the
    ///          device, and must not be modified.
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_hw_address")]
    #[doc(alias = "get_hw_address")]
    #[doc(alias = "hw-address")]
    pub fn hw_address(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_device_wimax_get_hw_address(self.to_glib_none().0))
        }
    }

    /// Gets a #NMWimaxNsp by path.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    /// ## `path`
    /// the object path of the NSP
    ///
    /// # Returns
    ///
    /// the access point or [`None`] if none is found.
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_nsp_by_path")]
    #[doc(alias = "get_nsp_by_path")]
    pub fn nsp_by_path(&self, path: &str) -> WimaxNsp {
        unsafe {
            from_glib_none(ffi::nm_device_wimax_get_nsp_by_path(self.to_glib_none().0, path.to_glib_none().0))
        }
    }

    /// Gets all the scanned NSPs of the #NMDeviceWimax.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// a #GPtrArray containing
    ///          all the scanned #NMWimaxNsps.
    /// The returned array is owned by the client and should not be modified.
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_nsps")]
    #[doc(alias = "get_nsps")]
    pub fn nsps(&self) -> Vec<WimaxNsp> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::nm_device_wimax_get_nsps(self.to_glib_none().0))
        }
    }

    /// Gets the RSSI of the current radio link in dBm.  This value indicates how
    /// strong the raw received RF signal from the base station is, but does not
    /// indicate the overall quality of the radio link.  Has no meaning when the
    /// device is not connected.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the RSSI in dBm, or 0
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_rssi")]
    #[doc(alias = "get_rssi")]
    pub fn rssi(&self) -> i32 {
        unsafe {
            ffi::nm_device_wimax_get_rssi(self.to_glib_none().0)
        }
    }

    /// Average power of the last burst transmitted by the device, in units of
    /// 0.5 dBm.  i.e. a TxPower of -11 represents an actual device TX power of
    /// -5.5 dBm.  Has no meaning when the device is not connected.
    ///
    /// # Deprecated since 1.2
    ///
    /// WiMAX is no longer supported.
    ///
    /// # Returns
    ///
    /// the TX power in dBm, or 0
    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[allow(deprecated)]
    #[doc(alias = "nm_device_wimax_get_tx_power")]
    #[doc(alias = "get_tx_power")]
    #[doc(alias = "tx-power")]
    pub fn tx_power(&self) -> i32 {
        unsafe {
            ffi::nm_device_wimax_get_tx_power(self.to_glib_none().0)
        }
    }

    //#[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    //#[doc(alias = "nsp-added")]
    //pub fn connect_nsp_added<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId {
    //    Ignored nsp: GObject.Object
    //}

    //#[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    //#[doc(alias = "nsp-removed")]
    //pub fn connect_nsp_removed<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId {
    //    Ignored nsp: GObject.Object
    //}

    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[doc(alias = "active-nsp")]
    pub fn connect_active_nsp_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_active_nsp_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::active-nsp".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_active_nsp_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[doc(alias = "bsid")]
    pub fn connect_bsid_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_bsid_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::bsid".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_bsid_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[doc(alias = "center-frequency")]
    pub fn connect_center_frequency_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_center_frequency_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::center-frequency".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_center_frequency_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[doc(alias = "cinr")]
    pub fn connect_cinr_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_cinr_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::cinr".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_cinr_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[doc(alias = "nsps")]
    pub fn connect_nsps_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_nsps_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::nsps".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_nsps_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[doc(alias = "rssi")]
    pub fn connect_rssi_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_rssi_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::rssi".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_rssi_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg_attr(feature = "v1_2", deprecated = "Since 1.2")]
    #[doc(alias = "tx-power")]
    pub fn connect_tx_power_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_tx_power_trampoline<F: Fn(&DeviceWimax) + 'static>(this: *mut ffi::NMDeviceWimax, _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 _, c"notify::tx-power".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_tx_power_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }
}

// rustdoc-stripper-ignore-next
        /// A [builder-pattern] type to construct [`DeviceWimax`] objects.
        ///
        /// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct DeviceWimaxBuilder {
            builder: glib::object::ObjectBuilder<'static, DeviceWimax>,
        }

        impl DeviceWimaxBuilder {
        fn new() -> Self {
            Self { builder: glib::object::Object::builder() }
        }

                            /// Whether the device can auto-activate a connection.
                            ///
                            /// The property setter is a synchronous D-Bus call. This is deprecated since 1.22.
                            pub fn autoconnect(self, autoconnect: bool) -> Self {
                            Self { builder: self.builder.property("autoconnect", autoconnect), }
                        }

    // rustdoc-stripper-ignore-next
    /// Build the [`DeviceWimax`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> DeviceWimax {
assert_initialized_main_thread!();
    self.builder.build() }
}