// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{ffi, RTSPAddress, RTSPAddressFlags};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// An address pool, all member are private
    ///
    /// # Implements
    ///
    /// [`RTSPAddressPoolExt`][trait@crate::prelude::RTSPAddressPoolExt], [`trait@glib::ObjectExt`], [`RTSPAddressPoolExtManual`][trait@crate::prelude::RTSPAddressPoolExtManual]
    #[doc(alias = "GstRTSPAddressPool")]
    pub struct RTSPAddressPool(Object<ffi::GstRTSPAddressPool, ffi::GstRTSPAddressPoolClass>);

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

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

    /// Make a new [`RTSPAddressPool`][crate::RTSPAddressPool].
    ///
    /// # Returns
    ///
    /// a new [`RTSPAddressPool`][crate::RTSPAddressPool]
    #[doc(alias = "gst_rtsp_address_pool_new")]
    pub fn new() -> RTSPAddressPool {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_rtsp_address_pool_new()) }
    }
}

impl Default for RTSPAddressPool {
    fn default() -> Self {
        Self::new()
    }
}

unsafe impl Send for RTSPAddressPool {}
unsafe impl Sync for RTSPAddressPool {}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::RTSPAddressPool>> Sealed for T {}
}

/// Trait containing all [`struct@RTSPAddressPool`] methods.
///
/// # Implementors
///
/// [`RTSPAddressPool`][struct@crate::RTSPAddressPool]
pub trait RTSPAddressPoolExt: IsA<RTSPAddressPool> + sealed::Sealed + 'static {
    /// Take an address and ports from `self`. `flags` can be used to control the
    /// allocation. `n_ports` consecutive ports will be allocated of which the first
    /// one can be found in `port`.
    /// ## `flags`
    /// flags
    /// ## `n_ports`
    /// the amount of ports
    ///
    /// # Returns
    ///
    /// a [`RTSPAddress`][crate::RTSPAddress] that should be freed with
    /// gst_rtsp_address_free after use or [`None`] when no address could be
    /// acquired.
    #[doc(alias = "gst_rtsp_address_pool_acquire_address")]
    fn acquire_address(
        &self,
        flags: RTSPAddressFlags,
        n_ports: i32,
    ) -> Result<RTSPAddress, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_rtsp_address_pool_acquire_address(
                self.as_ref().to_glib_none().0,
                flags.into_glib(),
                n_ports,
            ))
            .ok_or_else(|| glib::bool_error!("Failed to acquire address"))
        }
    }

    /// Adds the addresses from `min_addess` to `max_address` (inclusive)
    /// to `self`. The valid port range for the addresses will be from `min_port` to
    /// `max_port` inclusive.
    ///
    /// When `ttl` is 0, `min_address` and `max_address` should be unicast addresses.
    /// `min_address` and `max_address` can be set to
    /// `GST_RTSP_ADDRESS_POOL_ANY_IPV4` or `GST_RTSP_ADDRESS_POOL_ANY_IPV6` to bind
    /// to all available IPv4 or IPv6 addresses.
    ///
    /// When `ttl` > 0, `min_address` and `max_address` should be multicast addresses.
    /// ## `min_address`
    /// a minimum address to add
    /// ## `max_address`
    /// a maximum address to add
    /// ## `min_port`
    /// the minimum port
    /// ## `max_port`
    /// the maximum port
    /// ## `ttl`
    /// a TTL or 0 for unicast addresses
    ///
    /// # Returns
    ///
    /// [`true`] if the addresses could be added.
    #[doc(alias = "gst_rtsp_address_pool_add_range")]
    fn add_range(
        &self,
        min_address: &str,
        max_address: &str,
        min_port: u16,
        max_port: u16,
        ttl: u8,
    ) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::gst_rtsp_address_pool_add_range(
                    self.as_ref().to_glib_none().0,
                    min_address.to_glib_none().0,
                    max_address.to_glib_none().0,
                    min_port,
                    max_port,
                    ttl
                ),
                "Failed to add address range"
            )
        }
    }

    /// Clear all addresses in `self`. There should be no outstanding
    /// allocations.
    #[doc(alias = "gst_rtsp_address_pool_clear")]
    fn clear(&self) {
        unsafe {
            ffi::gst_rtsp_address_pool_clear(self.as_ref().to_glib_none().0);
        }
    }

    /// Dump the free and allocated addresses to stdout.
    #[doc(alias = "gst_rtsp_address_pool_dump")]
    fn dump(&self) {
        unsafe {
            ffi::gst_rtsp_address_pool_dump(self.as_ref().to_glib_none().0);
        }
    }

    /// Used to know if the pool includes any unicast addresses.
    ///
    /// # Returns
    ///
    /// [`true`] if the pool includes any unicast addresses, [`false`] otherwise
    #[doc(alias = "gst_rtsp_address_pool_has_unicast_addresses")]
    fn has_unicast_addresses(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_rtsp_address_pool_has_unicast_addresses(
                self.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<RTSPAddressPool>> RTSPAddressPoolExt for O {}