soup/auto/

websocket_connection.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{WebsocketConnectionType, WebsocketExtension, WebsocketState, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    #[doc(alias = "SoupWebsocketConnection")]
    pub struct WebsocketConnection(Object<ffi::SoupWebsocketConnection, ffi::SoupWebsocketConnectionClass>);

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

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

    #[doc(alias = "soup_websocket_connection_close")]
    pub fn close(&self, code: libc::c_ushort, data: Option<&str>) {
        unsafe {
            ffi::soup_websocket_connection_close(
                self.to_glib_none().0,
                code,
                data.to_glib_none().0,
            );
        }
    }

    #[doc(alias = "soup_websocket_connection_get_close_code")]
    #[doc(alias = "get_close_code")]
    pub fn close_code(&self) -> libc::c_ushort {
        unsafe { ffi::soup_websocket_connection_get_close_code(self.to_glib_none().0) }
    }

    #[doc(alias = "soup_websocket_connection_get_close_data")]
    #[doc(alias = "get_close_data")]
    pub fn close_data(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::soup_websocket_connection_get_close_data(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_connection_type")]
    #[doc(alias = "get_connection_type")]
    #[doc(alias = "connection-type")]
    pub fn connection_type(&self) -> WebsocketConnectionType {
        unsafe {
            from_glib(ffi::soup_websocket_connection_get_connection_type(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_extensions")]
    #[doc(alias = "get_extensions")]
    pub fn extensions(&self) -> Vec<WebsocketExtension> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::soup_websocket_connection_get_extensions(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_io_stream")]
    #[doc(alias = "get_io_stream")]
    #[doc(alias = "io-stream")]
    pub fn io_stream(&self) -> Option<gio::IOStream> {
        unsafe {
            from_glib_none(ffi::soup_websocket_connection_get_io_stream(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_keepalive_interval")]
    #[doc(alias = "get_keepalive_interval")]
    #[doc(alias = "keepalive-interval")]
    pub fn keepalive_interval(&self) -> u32 {
        unsafe { ffi::soup_websocket_connection_get_keepalive_interval(self.to_glib_none().0) }
    }

    #[cfg(feature = "v3_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_6")))]
    #[doc(alias = "soup_websocket_connection_get_keepalive_pong_timeout")]
    #[doc(alias = "get_keepalive_pong_timeout")]
    #[doc(alias = "keepalive-pong-timeout")]
    pub fn keepalive_pong_timeout(&self) -> u32 {
        unsafe { ffi::soup_websocket_connection_get_keepalive_pong_timeout(self.to_glib_none().0) }
    }

    #[doc(alias = "soup_websocket_connection_get_max_incoming_payload_size")]
    #[doc(alias = "get_max_incoming_payload_size")]
    #[doc(alias = "max-incoming-payload-size")]
    pub fn max_incoming_payload_size(&self) -> u64 {
        unsafe {
            ffi::soup_websocket_connection_get_max_incoming_payload_size(self.to_glib_none().0)
        }
    }

    #[cfg(feature = "v3_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_8")))]
    #[doc(alias = "soup_websocket_connection_get_max_total_message_size")]
    #[doc(alias = "get_max_total_message_size")]
    #[doc(alias = "max-total-message-size")]
    pub fn max_total_message_size(&self) -> u64 {
        unsafe { ffi::soup_websocket_connection_get_max_total_message_size(self.to_glib_none().0) }
    }

    #[doc(alias = "soup_websocket_connection_get_origin")]
    #[doc(alias = "get_origin")]
    pub fn origin(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::soup_websocket_connection_get_origin(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_protocol")]
    #[doc(alias = "get_protocol")]
    pub fn protocol(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::soup_websocket_connection_get_protocol(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_state")]
    #[doc(alias = "get_state")]
    pub fn state(&self) -> WebsocketState {
        unsafe {
            from_glib(ffi::soup_websocket_connection_get_state(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_get_uri")]
    #[doc(alias = "get_uri")]
    pub fn uri(&self) -> Option<glib::Uri> {
        unsafe {
            from_glib_none(ffi::soup_websocket_connection_get_uri(
                self.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "soup_websocket_connection_send_text")]
    pub fn send_text(&self, text: &str) {
        unsafe {
            ffi::soup_websocket_connection_send_text(self.to_glib_none().0, text.to_glib_none().0);
        }
    }

    #[doc(alias = "soup_websocket_connection_set_keepalive_interval")]
    #[doc(alias = "keepalive-interval")]
    pub fn set_keepalive_interval(&self, interval: u32) {
        unsafe {
            ffi::soup_websocket_connection_set_keepalive_interval(self.to_glib_none().0, interval);
        }
    }

    #[cfg(feature = "v3_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_6")))]
    #[doc(alias = "soup_websocket_connection_set_keepalive_pong_timeout")]
    #[doc(alias = "keepalive-pong-timeout")]
    pub fn set_keepalive_pong_timeout(&self, pong_timeout: u32) {
        unsafe {
            ffi::soup_websocket_connection_set_keepalive_pong_timeout(
                self.to_glib_none().0,
                pong_timeout,
            );
        }
    }

    #[doc(alias = "soup_websocket_connection_set_max_incoming_payload_size")]
    #[doc(alias = "max-incoming-payload-size")]
    pub fn set_max_incoming_payload_size(&self, max_incoming_payload_size: u64) {
        unsafe {
            ffi::soup_websocket_connection_set_max_incoming_payload_size(
                self.to_glib_none().0,
                max_incoming_payload_size,
            );
        }
    }

    #[cfg(feature = "v3_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_8")))]
    #[doc(alias = "soup_websocket_connection_set_max_total_message_size")]
    #[doc(alias = "max-total-message-size")]
    pub fn set_max_total_message_size(&self, max_total_message_size: u64) {
        unsafe {
            ffi::soup_websocket_connection_set_max_total_message_size(
                self.to_glib_none().0,
                max_total_message_size,
            );
        }
    }

    #[doc(alias = "closed")]
    pub fn connect_closed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn closed_trampoline<F: Fn(&WebsocketConnection) + 'static>(
            this: *mut ffi::SoupWebsocketConnection,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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"closed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    closed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "closing")]
    pub fn connect_closing<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn closing_trampoline<F: Fn(&WebsocketConnection) + 'static>(
            this: *mut ffi::SoupWebsocketConnection,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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"closing".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    closing_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "error")]
    pub fn connect_error<F: Fn(&Self, &glib::Error) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn error_trampoline<
            F: Fn(&WebsocketConnection, &glib::Error) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            error: *mut glib::ffi::GError,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this), &from_glib_borrow(error))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"error".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    error_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "message")]
    pub fn connect_message<F: Fn(&Self, i32, &glib::Bytes) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn message_trampoline<
            F: Fn(&WebsocketConnection, i32, &glib::Bytes) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            type_: std::ffi::c_int,
            message: *mut glib::ffi::GBytes,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this), type_, &from_glib_borrow(message))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"message".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    message_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "pong")]
    pub fn connect_pong<F: Fn(&Self, &glib::Bytes) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn pong_trampoline<
            F: Fn(&WebsocketConnection, &glib::Bytes) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            message: *mut glib::ffi::GBytes,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this), &from_glib_borrow(message))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"pong".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    pong_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "keepalive-interval")]
    pub fn connect_keepalive_interval_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_keepalive_interval_trampoline<
            F: Fn(&WebsocketConnection) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::keepalive-interval".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_keepalive_interval_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v3_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_6")))]
    #[doc(alias = "keepalive-pong-timeout")]
    pub fn connect_keepalive_pong_timeout_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_keepalive_pong_timeout_trampoline<
            F: Fn(&WebsocketConnection) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::keepalive-pong-timeout".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_keepalive_pong_timeout_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "max-incoming-payload-size")]
    pub fn connect_max_incoming_payload_size_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_incoming_payload_size_trampoline<
            F: Fn(&WebsocketConnection) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::max-incoming-payload-size".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_max_incoming_payload_size_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v3_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_8")))]
    #[doc(alias = "max-total-message-size")]
    pub fn connect_max_total_message_size_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_total_message_size_trampoline<
            F: Fn(&WebsocketConnection) + 'static,
        >(
            this: *mut ffi::SoupWebsocketConnection,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::max-total-message-size".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_max_total_message_size_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "state")]
    pub fn connect_state_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_state_trampoline<F: Fn(&WebsocketConnection) + 'static>(
            this: *mut ffi::SoupWebsocketConnection,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::state".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_state_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

    pub fn connection_type(self, connection_type: WebsocketConnectionType) -> Self {
        Self {
            builder: self.builder.property("connection-type", connection_type),
        }
    }

    //pub fn extensions(self, extensions: /*Unimplemented*/Basic: Pointer) -> Self {
    //    Self { builder: self.builder.property("extensions", extensions), }
    //}

    pub fn io_stream(self, io_stream: &impl IsA<gio::IOStream>) -> Self {
        Self {
            builder: self
                .builder
                .property("io-stream", io_stream.clone().upcast()),
        }
    }

    pub fn keepalive_interval(self, keepalive_interval: u32) -> Self {
        Self {
            builder: self
                .builder
                .property("keepalive-interval", keepalive_interval),
        }
    }

    #[cfg(feature = "v3_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_6")))]
    pub fn keepalive_pong_timeout(self, keepalive_pong_timeout: u32) -> Self {
        Self {
            builder: self
                .builder
                .property("keepalive-pong-timeout", keepalive_pong_timeout),
        }
    }

    pub fn max_incoming_payload_size(self, max_incoming_payload_size: u64) -> Self {
        Self {
            builder: self
                .builder
                .property("max-incoming-payload-size", max_incoming_payload_size),
        }
    }

    #[cfg(feature = "v3_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_8")))]
    pub fn max_total_message_size(self, max_total_message_size: u64) -> Self {
        Self {
            builder: self
                .builder
                .property("max-total-message-size", max_total_message_size),
        }
    }

    pub fn origin(self, origin: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("origin", origin.into()),
        }
    }

    pub fn protocol(self, protocol: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("protocol", protocol.into()),
        }
    }

    pub fn uri(self, uri: &glib::Uri) -> Self {
        Self {
            builder: self.builder.property("uri", uri.clone()),
        }
    }

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