gstreamer_rtsp_server/auto/

rtsp_session.rs

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

glib::wrapper! {
    /// Session information kept by the server for a specific client.
    /// One client session, identified with a session id, can handle multiple medias
    /// identified with the url of a media.
    ///
    /// ## Properties
    ///
    ///
    /// #### `extra-timeout`
    ///  Readable | Writeable
    ///
    ///
    /// #### `sessionid`
    ///  Readable | Writeable | Construct Only
    ///
    ///
    /// #### `timeout`
    ///  Readable | Writeable
    ///
    ///
    /// #### `timeout-always-visible`
    ///  Readable | Writeable
    ///
    /// # Implements
    ///
    /// [`RTSPSessionExt`][trait@crate::prelude::RTSPSessionExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstRTSPSession")]
    pub struct RTSPSession(Object<ffi::GstRTSPSession, ffi::GstRTSPSessionClass>);

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

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

    /// Create a new [`RTSPSession`][crate::RTSPSession] instance with `sessionid`.
    /// ## `sessionid`
    /// a session id
    ///
    /// # Returns
    ///
    /// a new [`RTSPSession`][crate::RTSPSession]
    #[doc(alias = "gst_rtsp_session_new")]
    pub fn new(sessionid: &str) -> RTSPSession {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_rtsp_session_new(sessionid.to_glib_none().0)) }
    }
}

unsafe impl Send for RTSPSession {}
unsafe impl Sync for RTSPSession {}

/// Trait containing all [`struct@RTSPSession`] methods.
///
/// # Implementors
///
/// [`RTSPSession`][struct@crate::RTSPSession]
pub trait RTSPSessionExt: IsA<RTSPSession> + 'static {
    /// Allow `self` to expire. This method must be called an equal
    /// amount of time as [`prevent_expire()`][Self::prevent_expire()].
    #[doc(alias = "gst_rtsp_session_allow_expire")]
    fn allow_expire(&self) {
        unsafe {
            ffi::gst_rtsp_session_allow_expire(self.as_ref().to_glib_none().0);
        }
    }

    /// Call `func` for each media in `self`. The result value of `func` determines
    /// what happens to the media. `func` will be called with `self`
    /// locked so no further actions on `self` can be performed from `func`.
    ///
    /// If `func` returns [`RTSPFilterResult::Remove`][crate::RTSPFilterResult::Remove], the media will be removed from
    /// `self`.
    ///
    /// If `func` returns [`RTSPFilterResult::Keep`][crate::RTSPFilterResult::Keep], the media will remain in `self`.
    ///
    /// If `func` returns [`RTSPFilterResult::Ref`][crate::RTSPFilterResult::Ref], the media will remain in `self` but
    /// will also be added with an additional ref to the result `GList` of this
    /// function..
    ///
    /// When `func` is [`None`], [`RTSPFilterResult::Ref`][crate::RTSPFilterResult::Ref] will be assumed for all media.
    /// ## `func`
    /// a callback
    ///
    /// # Returns
    ///
    /// a GList with all
    /// media for which `func` returned [`RTSPFilterResult::Ref`][crate::RTSPFilterResult::Ref]. After usage, each
    /// element in the `GList` should be unreffed before the list is freed.
    #[doc(alias = "gst_rtsp_session_filter")]
    fn filter(
        &self,
        func: Option<&mut dyn FnMut(&RTSPSession, &RTSPSessionMedia) -> RTSPFilterResult>,
    ) -> Vec<RTSPSessionMedia> {
        let mut func_data: Option<
            &mut dyn FnMut(&RTSPSession, &RTSPSessionMedia) -> RTSPFilterResult,
        > = func;
        unsafe extern "C" fn func_func(
            sess: *mut ffi::GstRTSPSession,
            media: *mut ffi::GstRTSPSessionMedia,
            user_data: glib::ffi::gpointer,
        ) -> ffi::GstRTSPFilterResult {
            let sess = from_glib_borrow(sess);
            let media = from_glib_borrow(media);
            let callback = user_data
                as *mut Option<&mut dyn FnMut(&RTSPSession, &RTSPSessionMedia) -> RTSPFilterResult>;
            if let Some(ref mut callback) = *callback {
                callback(&sess, &media)
            } else {
                panic!("cannot get closure...")
            }
            .into_glib()
        }
        let func = if func_data.is_some() {
            Some(func_func as _)
        } else {
            None
        };
        let super_callback0: &mut Option<
            &mut dyn FnMut(&RTSPSession, &RTSPSessionMedia) -> RTSPFilterResult,
        > = &mut func_data;
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_rtsp_session_filter(
                self.as_ref().to_glib_none().0,
                func,
                super_callback0 as *mut _ as *mut _,
            ))
        }
    }

    /// Get the string that can be placed in the Session header field.
    ///
    /// # Returns
    ///
    /// the Session header of `self`.
    /// `g_free()` after usage.
    #[doc(alias = "gst_rtsp_session_get_header")]
    #[doc(alias = "get_header")]
    fn header(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::gst_rtsp_session_get_header(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the sessionid of `self`.
    ///
    /// # Returns
    ///
    /// the sessionid of `self`.
    /// The value remains valid as long as `self` is alive.
    #[doc(alias = "gst_rtsp_session_get_sessionid")]
    #[doc(alias = "get_sessionid")]
    fn sessionid(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gst_rtsp_session_get_sessionid(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the timeout value of `self`.
    ///
    /// # Returns
    ///
    /// the timeout of `self` in seconds.
    #[doc(alias = "gst_rtsp_session_get_timeout")]
    #[doc(alias = "get_timeout")]
    fn timeout(&self) -> u32 {
        unsafe { ffi::gst_rtsp_session_get_timeout(self.as_ref().to_glib_none().0) }
    }

    //#[doc(alias = "gst_rtsp_session_is_expired")]
    //fn is_expired(&self, now: /*Ignored*/&mut glib::TimeVal) -> bool {
    //    unsafe { TODO: call ffi:gst_rtsp_session_is_expired() }
    //}

    /// Check if `self` timeout out.
    /// ## `now`
    /// the current monotonic time
    ///
    /// # Returns
    ///
    /// [`true`] if `self` timed out
    #[doc(alias = "gst_rtsp_session_is_expired_usec")]
    fn is_expired_usec(&self, now: i64) -> bool {
        unsafe {
            from_glib(ffi::gst_rtsp_session_is_expired_usec(
                self.as_ref().to_glib_none().0,
                now,
            ))
        }
    }

    /// Manage the media object `obj` in `self`. `path` will be used to retrieve this
    /// media from the session with [`RTSPSessionExtManual::media()`][crate::prelude::RTSPSessionExtManual::media()].
    ///
    /// Ownership is taken from `media`.
    /// ## `path`
    /// the path for the media
    /// ## `media`
    /// a [`RTSPMedia`][crate::RTSPMedia]
    ///
    /// # Returns
    ///
    /// a new [`RTSPSessionMedia`][crate::RTSPSessionMedia] object.
    #[doc(alias = "gst_rtsp_session_manage_media")]
    fn manage_media(&self, path: &str, media: impl IsA<RTSPMedia>) -> RTSPSessionMedia {
        unsafe {
            from_glib_none(ffi::gst_rtsp_session_manage_media(
                self.as_ref().to_glib_none().0,
                path.to_glib_none().0,
                media.upcast().into_glib_ptr(),
            ))
        }
    }

    //#[doc(alias = "gst_rtsp_session_next_timeout")]
    //fn next_timeout(&self, now: /*Ignored*/&mut glib::TimeVal) -> i32 {
    //    unsafe { TODO: call ffi:gst_rtsp_session_next_timeout() }
    //}

    /// Get the amount of milliseconds till the session will expire.
    /// ## `now`
    /// the current monotonic time
    ///
    /// # Returns
    ///
    /// the amount of milliseconds since the session will time out.
    #[doc(alias = "gst_rtsp_session_next_timeout_usec")]
    fn next_timeout_usec(&self, now: i64) -> i32 {
        unsafe { ffi::gst_rtsp_session_next_timeout_usec(self.as_ref().to_glib_none().0, now) }
    }

    /// Prevent `self` from expiring.
    #[doc(alias = "gst_rtsp_session_prevent_expire")]
    fn prevent_expire(&self) {
        unsafe {
            ffi::gst_rtsp_session_prevent_expire(self.as_ref().to_glib_none().0);
        }
    }

    /// Release the managed `media` in `self`, freeing the memory allocated by it.
    /// ## `media`
    /// a [`RTSPMedia`][crate::RTSPMedia]
    ///
    /// # Returns
    ///
    /// [`true`] if there are more media session left in `self`.
    #[doc(alias = "gst_rtsp_session_release_media")]
    fn release_media(&self, media: &impl IsA<RTSPSessionMedia>) -> bool {
        unsafe {
            from_glib(ffi::gst_rtsp_session_release_media(
                self.as_ref().to_glib_none().0,
                media.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Configure `self` for a timeout of `timeout` seconds. The session will be
    /// cleaned up when there is no activity for `timeout` seconds.
    /// ## `timeout`
    /// the new timeout
    #[doc(alias = "gst_rtsp_session_set_timeout")]
    #[doc(alias = "timeout")]
    fn set_timeout(&self, timeout: u32) {
        unsafe {
            ffi::gst_rtsp_session_set_timeout(self.as_ref().to_glib_none().0, timeout);
        }
    }

    /// Update the last_access time of the session to the current time.
    #[doc(alias = "gst_rtsp_session_touch")]
    fn touch(&self) {
        unsafe {
            ffi::gst_rtsp_session_touch(self.as_ref().to_glib_none().0);
        }
    }

    #[doc(alias = "extra-timeout")]
    fn extra_timeout(&self) -> u32 {
        ObjectExt::property(self.as_ref(), "extra-timeout")
    }

    #[doc(alias = "extra-timeout")]
    fn set_extra_timeout(&self, extra_timeout: u32) {
        ObjectExt::set_property(self.as_ref(), "extra-timeout", extra_timeout)
    }

    #[doc(alias = "timeout-always-visible")]
    fn is_timeout_always_visible(&self) -> bool {
        ObjectExt::property(self.as_ref(), "timeout-always-visible")
    }

    #[doc(alias = "timeout-always-visible")]
    fn set_timeout_always_visible(&self, timeout_always_visible: bool) {
        ObjectExt::set_property(
            self.as_ref(),
            "timeout-always-visible",
            timeout_always_visible,
        )
    }

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

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

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

impl<O: IsA<RTSPSession>> RTSPSessionExt for O {}