gio/auto/

network_service.rs

// 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, SocketConnectable};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Like [`NetworkAddress`][crate::NetworkAddress] does with hostnames, `GNetworkService`
    /// provides an easy way to resolve a SRV record, and then attempt to
    /// connect to one of the hosts that implements that service, handling
    /// service priority/weighting, multiple IP addresses, and multiple
    /// address families.
    ///
    /// See [`SrvTarget`][crate::SrvTarget] for more information about SRV records, and see
    /// [`SocketConnectable`][crate::SocketConnectable] for an example of using the connectable
    /// interface.
    ///
    /// ## Properties
    ///
    ///
    /// #### `domain`
    ///  Network domain, for example `example.com`.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `protocol`
    ///  Network protocol, for example `tcp`.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `scheme`
    ///  Network scheme (default is to use service).
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `service`
    ///  Service name, for example `ldap`.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`NetworkServiceExt`][trait@crate::prelude::NetworkServiceExt], [`trait@glib::ObjectExt`], [`SocketConnectableExt`][trait@crate::prelude::SocketConnectableExt]
    #[doc(alias = "GNetworkService")]
    pub struct NetworkService(Object<ffi::GNetworkService, ffi::GNetworkServiceClass>) @implements SocketConnectable;

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

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

    /// Creates a new #GNetworkService representing the given @service,
    /// @protocol, and @domain. This will initially be unresolved; use the
    /// #GSocketConnectable interface to resolve it.
    /// ## `service`
    /// the service type to look up (eg, "ldap")
    /// ## `protocol`
    /// the networking protocol to use for @service (eg, "tcp")
    /// ## `domain`
    /// the DNS domain to look up the service in
    ///
    /// # Returns
    ///
    /// a new #GNetworkService
    #[doc(alias = "g_network_service_new")]
    pub fn new(service: &str, protocol: &str, domain: &str) -> NetworkService {
        unsafe {
            from_glib_full(ffi::g_network_service_new(
                service.to_glib_none().0,
                protocol.to_glib_none().0,
                domain.to_glib_none().0,
            ))
        }
    }
}

/// Trait containing all [`struct@NetworkService`] methods.
///
/// # Implementors
///
/// [`NetworkService`][struct@crate::NetworkService]
pub trait NetworkServiceExt: IsA<NetworkService> + 'static {
    /// Gets the domain that @self serves. This might be either UTF-8 or
    /// ASCII-encoded, depending on what @self was created with.
    ///
    /// # Returns
    ///
    /// @self's domain name
    #[doc(alias = "g_network_service_get_domain")]
    #[doc(alias = "get_domain")]
    fn domain(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::g_network_service_get_domain(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets @self's protocol name (eg, "tcp").
    ///
    /// # Returns
    ///
    /// @self's protocol name
    #[doc(alias = "g_network_service_get_protocol")]
    #[doc(alias = "get_protocol")]
    fn protocol(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::g_network_service_get_protocol(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the URI scheme used to resolve proxies. By default, the service name
    /// is used as scheme.
    ///
    /// # Returns
    ///
    /// @self's scheme name
    #[doc(alias = "g_network_service_get_scheme")]
    #[doc(alias = "get_scheme")]
    fn scheme(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::g_network_service_get_scheme(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets @self's service name (eg, "ldap").
    ///
    /// # Returns
    ///
    /// @self's service name
    #[doc(alias = "g_network_service_get_service")]
    #[doc(alias = "get_service")]
    fn service(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::g_network_service_get_service(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Set's the URI scheme used to resolve proxies. By default, the service name
    /// is used as scheme.
    /// ## `scheme`
    /// a URI scheme
    #[doc(alias = "g_network_service_set_scheme")]
    #[doc(alias = "scheme")]
    fn set_scheme(&self, scheme: &str) {
        unsafe {
            ffi::g_network_service_set_scheme(
                self.as_ref().to_glib_none().0,
                scheme.to_glib_none().0,
            );
        }
    }

    #[doc(alias = "scheme")]
    fn connect_scheme_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_scheme_trampoline<
            P: IsA<NetworkService>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GNetworkService,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(NetworkService::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::scheme".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_scheme_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<NetworkService>> NetworkServiceExt for O {}