nm-rs 0.1.3

Rust bindings for the libnm library.
Documentation
// 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

use crate::{ffi,Setting};
#[cfg(feature = "v1_54")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_54")))]
use crate::{SettingOvsDpdkLscInterrupt};
use glib::{prelude::*};
#[cfg(feature = "v1_20")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
use glib::{signal::{connect_raw, SignalHandlerId},translate::*};
#[cfg(feature = "v1_20")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
use std::{boxed::Box as Box_};

glib::wrapper! {
    /// OvsDpdk Link Settings
    ///
    /// ## Properties
    ///
    ///
    /// #### `devargs`
    ///  Open vSwitch DPDK device arguments.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `lsc-interrupt`
    ///  Configures the Link State Change (LSC) detection mode for the OVS DPDK interface.
    /// When set to [`SettingOvsDpdkLscInterrupt::Ignore`][crate::SettingOvsDpdkLscInterrupt::Ignore], NetworkManager doesn't
    /// change the default value configured by Open vSwitch.
    /// [`SettingOvsDpdkLscInterrupt::Enabled`][crate::SettingOvsDpdkLscInterrupt::Enabled] enables interrupts.
    /// [`SettingOvsDpdkLscInterrupt::Disabled`][crate::SettingOvsDpdkLscInterrupt::Disabled] disables interrupts, thus setting the
    /// interface in poll mode.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `n-rxq`
    ///  Open vSwitch DPDK number of rx queues.
    /// Defaults to zero which means to leave the parameter in OVS unspecified
    /// and effectively configures one queue.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `n-rxq-desc`
    ///  The rx queue size (number of rx descriptors) for DPDK ports.
    /// Must be zero or a power of 2 between 1 and 4096, and supported
    /// by the hardware. Defaults to zero which means to leave the
    /// parameter in OVS unspecified and effectively configures 2048
    /// descriptors.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `n-txq-desc`
    ///  The tx queue size (number of tx descriptors) for DPDK ports.
    /// Must be zero or a power of 2 between 1 and 4096, and supported
    /// by the hardware. Defaults to zero which means to leave the
    /// parameter in OVS unspecified and effectively configures 2048
    /// descriptors.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Setting</h4></summary>
    ///
    ///
    /// #### `name`
    ///  The setting's name, which uniquely identifies the setting within the
    /// connection.  Each setting type has a name unique to that type, for
    /// example "ppp" or "802-11-wireless" or "802-3-ethernet".
    ///
    /// Readable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`SettingExt`][trait@crate::prelude::SettingExt]
    #[doc(alias = "NMSettingOvsDpdk")]
    pub struct SettingOvsDpdk(Object<ffi::NMSettingOvsDpdk, ffi::NMSettingOvsDpdkClass>) @extends Setting;

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

impl SettingOvsDpdk {
    /// Creates a new #NMSettingOvsDpdk object with default values.
    ///
    /// # Returns
    ///
    /// the new empty #NMSettingOvsDpdk object
    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    #[doc(alias = "nm_setting_ovs_dpdk_new")]
    pub fn new() -> SettingOvsDpdk {
        assert_initialized_main_thread!();
        unsafe {
            Setting::from_glib_full(ffi::nm_setting_ovs_dpdk_new()).unsafe_cast()
        }
    }

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

    ///
    /// # Returns
    ///
    /// the #NMSettingOvsDpdk:devargs property of the setting
    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    #[doc(alias = "nm_setting_ovs_dpdk_get_devargs")]
    #[doc(alias = "get_devargs")]
    pub fn devargs(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_setting_ovs_dpdk_get_devargs(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingOvsDpdk:lsc-interrupt property of the setting
    #[cfg(feature = "v1_54")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_54")))]
    #[doc(alias = "nm_setting_ovs_dpdk_get_lsc_interrupt")]
    #[doc(alias = "get_lsc_interrupt")]
    #[doc(alias = "lsc-interrupt")]
    pub fn lsc_interrupt(&self) -> SettingOvsDpdkLscInterrupt {
        unsafe {
            from_glib(ffi::nm_setting_ovs_dpdk_get_lsc_interrupt(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingOvsDpdk:n-rxq property of the setting
    #[cfg(feature = "v1_36")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_36")))]
    #[doc(alias = "nm_setting_ovs_dpdk_get_n_rxq")]
    #[doc(alias = "get_n_rxq")]
    #[doc(alias = "n-rxq")]
    pub fn n_rxq(&self) -> u32 {
        unsafe {
            ffi::nm_setting_ovs_dpdk_get_n_rxq(self.to_glib_none().0)
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingOvsDpdk:n-rxq-desc property of the setting
    #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    #[doc(alias = "nm_setting_ovs_dpdk_get_n_rxq_desc")]
    #[doc(alias = "get_n_rxq_desc")]
    #[doc(alias = "n-rxq-desc")]
    pub fn n_rxq_desc(&self) -> u32 {
        unsafe {
            ffi::nm_setting_ovs_dpdk_get_n_rxq_desc(self.to_glib_none().0)
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingOvsDpdk:n-txq-desc property of the setting
    #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    #[doc(alias = "nm_setting_ovs_dpdk_get_n_txq_desc")]
    #[doc(alias = "get_n_txq_desc")]
    #[doc(alias = "n-txq-desc")]
    pub fn n_txq_desc(&self) -> u32 {
        unsafe {
            ffi::nm_setting_ovs_dpdk_get_n_txq_desc(self.to_glib_none().0)
        }
    }

    /// Open vSwitch DPDK device arguments.
    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    pub fn set_devargs(&self, devargs: Option<&str>) {
        ObjectExt::set_property(self,"devargs", devargs)
    }

    /// Configures the Link State Change (LSC) detection mode for the OVS DPDK interface.
    /// When set to [`SettingOvsDpdkLscInterrupt::Ignore`][crate::SettingOvsDpdkLscInterrupt::Ignore], NetworkManager doesn't
    /// change the default value configured by Open vSwitch.
    /// [`SettingOvsDpdkLscInterrupt::Enabled`][crate::SettingOvsDpdkLscInterrupt::Enabled] enables interrupts.
    /// [`SettingOvsDpdkLscInterrupt::Disabled`][crate::SettingOvsDpdkLscInterrupt::Disabled] disables interrupts, thus setting the
    /// interface in poll mode.
    #[cfg(feature = "v1_54")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_54")))]
    #[doc(alias = "lsc-interrupt")]
    pub fn set_lsc_interrupt(&self, lsc_interrupt: i32) {
        ObjectExt::set_property(self,"lsc-interrupt", lsc_interrupt)
    }

    /// Open vSwitch DPDK number of rx queues.
    /// Defaults to zero which means to leave the parameter in OVS unspecified
    /// and effectively configures one queue.
    #[cfg(feature = "v1_36")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_36")))]
    #[doc(alias = "n-rxq")]
    pub fn set_n_rxq(&self, n_rxq: u32) {
        ObjectExt::set_property(self,"n-rxq", n_rxq)
    }

    /// The rx queue size (number of rx descriptors) for DPDK ports.
    /// Must be zero or a power of 2 between 1 and 4096, and supported
    /// by the hardware. Defaults to zero which means to leave the
    /// parameter in OVS unspecified and effectively configures 2048
    /// descriptors.
    #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    #[doc(alias = "n-rxq-desc")]
    pub fn set_n_rxq_desc(&self, n_rxq_desc: u32) {
        ObjectExt::set_property(self,"n-rxq-desc", n_rxq_desc)
    }

    /// The tx queue size (number of tx descriptors) for DPDK ports.
    /// Must be zero or a power of 2 between 1 and 4096, and supported
    /// by the hardware. Defaults to zero which means to leave the
    /// parameter in OVS unspecified and effectively configures 2048
    /// descriptors.
    #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    #[doc(alias = "n-txq-desc")]
    pub fn set_n_txq_desc(&self, n_txq_desc: u32) {
        ObjectExt::set_property(self,"n-txq-desc", n_txq_desc)
    }

    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    #[doc(alias = "devargs")]
    pub fn connect_devargs_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_devargs_trampoline<F: Fn(&SettingOvsDpdk) + 'static>(this: *mut ffi::NMSettingOvsDpdk, _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::devargs".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_devargs_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_54")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_54")))]
    #[doc(alias = "lsc-interrupt")]
    pub fn connect_lsc_interrupt_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_lsc_interrupt_trampoline<F: Fn(&SettingOvsDpdk) + 'static>(this: *mut ffi::NMSettingOvsDpdk, _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::lsc-interrupt".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_lsc_interrupt_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_36")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_36")))]
    #[doc(alias = "n-rxq")]
    pub fn connect_n_rxq_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_n_rxq_trampoline<F: Fn(&SettingOvsDpdk) + 'static>(this: *mut ffi::NMSettingOvsDpdk, _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::n-rxq".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_n_rxq_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    #[doc(alias = "n-rxq-desc")]
    pub fn connect_n_rxq_desc_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_n_rxq_desc_trampoline<F: Fn(&SettingOvsDpdk) + 'static>(this: *mut ffi::NMSettingOvsDpdk, _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::n-rxq-desc".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_n_rxq_desc_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    #[doc(alias = "n-txq-desc")]
    pub fn connect_n_txq_desc_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_n_txq_desc_trampoline<F: Fn(&SettingOvsDpdk) + 'static>(this: *mut ffi::NMSettingOvsDpdk, _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::n-txq-desc".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_n_txq_desc_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }
}

#[cfg(feature = "v1_20")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
impl Default for SettingOvsDpdk {
                     fn default() -> Self {
                         Self::new()
                     }
                 }

// rustdoc-stripper-ignore-next
        /// A [builder-pattern] type to construct [`SettingOvsDpdk`] 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 SettingOvsDpdkBuilder {
            builder: glib::object::ObjectBuilder<'static, SettingOvsDpdk>,
        }

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

                            /// Open vSwitch DPDK device arguments.
                            #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    pub fn devargs(self, devargs: impl Into<glib::GString>) -> Self {
                            Self { builder: self.builder.property("devargs", devargs.into()), }
                        }

                            /// Configures the Link State Change (LSC) detection mode for the OVS DPDK interface.
                            /// When set to [`SettingOvsDpdkLscInterrupt::Ignore`][crate::SettingOvsDpdkLscInterrupt::Ignore], NetworkManager doesn't
                            /// change the default value configured by Open vSwitch.
                            /// [`SettingOvsDpdkLscInterrupt::Enabled`][crate::SettingOvsDpdkLscInterrupt::Enabled] enables interrupts.
                            /// [`SettingOvsDpdkLscInterrupt::Disabled`][crate::SettingOvsDpdkLscInterrupt::Disabled] disables interrupts, thus setting the
                            /// interface in poll mode.
                            #[cfg(feature = "v1_54")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_54")))]
    pub fn lsc_interrupt(self, lsc_interrupt: i32) -> Self {
                            Self { builder: self.builder.property("lsc-interrupt", lsc_interrupt), }
                        }

                            /// Open vSwitch DPDK number of rx queues.
                            /// Defaults to zero which means to leave the parameter in OVS unspecified
                            /// and effectively configures one queue.
                            #[cfg(feature = "v1_36")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_36")))]
    pub fn n_rxq(self, n_rxq: u32) -> Self {
                            Self { builder: self.builder.property("n-rxq", n_rxq), }
                        }

                            /// The rx queue size (number of rx descriptors) for DPDK ports.
                            /// Must be zero or a power of 2 between 1 and 4096, and supported
                            /// by the hardware. Defaults to zero which means to leave the
                            /// parameter in OVS unspecified and effectively configures 2048
                            /// descriptors.
                            #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    pub fn n_rxq_desc(self, n_rxq_desc: u32) -> Self {
                            Self { builder: self.builder.property("n-rxq-desc", n_rxq_desc), }
                        }

                            /// The tx queue size (number of tx descriptors) for DPDK ports.
                            /// Must be zero or a power of 2 between 1 and 4096, and supported
                            /// by the hardware. Defaults to zero which means to leave the
                            /// parameter in OVS unspecified and effectively configures 2048
                            /// descriptors.
                            #[cfg(feature = "v1_42")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_42")))]
    pub fn n_txq_desc(self, n_txq_desc: u32) -> Self {
                            Self { builder: self.builder.property("n-txq-desc", n_txq_desc), }
                        }

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