gio/auto/

socket_connection.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, AsyncResult, Cancellable, IOStream, Socket, SocketAddress, SocketFamily, SocketType,
};
use glib::{prelude::*, translate::*};
use std::{boxed::Box as Box_, pin::Pin};

glib::wrapper! {
    /// `GSocketConnection` is a [`IOStream`][crate::IOStream] for a connected socket. They
    /// can be created either by [`SocketClient`][crate::SocketClient] when connecting to a host,
    /// or by [`SocketListener`][crate::SocketListener] when accepting a new client.
    ///
    /// The type of the `GSocketConnection` object returned from these calls
    /// depends on the type of the underlying socket that is in use. For
    /// instance, for a TCP/IP connection it will be a [`TcpConnection`][crate::TcpConnection].
    ///
    /// Choosing what type of object to construct is done with the socket
    /// connection factory, and it is possible for third parties to register
    /// custom socket connection types for specific combination of socket
    /// family/type/protocol using [`factory_register_type()`][Self::factory_register_type()].
    ///
    /// To close a `GSocketConnection`, use [`IOStreamExt::close()`][crate::prelude::IOStreamExt::close()]. Closing both
    /// substreams of the [`IOStream`][crate::IOStream] separately will not close the
    /// underlying [`Socket`][crate::Socket].
    ///
    /// ## Properties
    ///
    ///
    /// #### `socket`
    ///  The underlying [`Socket`][crate::Socket].
    ///
    /// Readable | Writeable | Construct Only
    /// <details><summary><h4>IOStream</h4></summary>
    ///
    ///
    /// #### `closed`
    ///  Whether the stream is closed.
    ///
    /// Readable
    ///
    ///
    /// #### `input-stream`
    ///  The [`InputStream`][crate::InputStream] to read from.
    ///
    /// Readable
    ///
    ///
    /// #### `output-stream`
    ///  The [`OutputStream`][crate::OutputStream] to write to.
    ///
    /// Readable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`SocketConnectionExt`][trait@crate::prelude::SocketConnectionExt], [`IOStreamExt`][trait@crate::prelude::IOStreamExt], [`trait@glib::ObjectExt`], [`IOStreamExtManual`][trait@crate::prelude::IOStreamExtManual]
    #[doc(alias = "GSocketConnection")]
    pub struct SocketConnection(Object<ffi::GSocketConnection, ffi::GSocketConnectionClass>) @extends IOStream;

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

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

    /// Looks up the #GType to be used when creating socket connections on
    /// sockets with the specified @family, @type_ and @protocol_id.
    ///
    /// If no type is registered, the #GSocketConnection base type is returned.
    /// ## `family`
    /// a #GSocketFamily
    /// ## `type_`
    /// a #GSocketType
    /// ## `protocol_id`
    /// a protocol id
    ///
    /// # Returns
    ///
    /// a #GType
    #[doc(alias = "g_socket_connection_factory_lookup_type")]
    pub fn factory_lookup_type(
        family: SocketFamily,
        type_: SocketType,
        protocol_id: i32,
    ) -> glib::types::Type {
        unsafe {
            from_glib(ffi::g_socket_connection_factory_lookup_type(
                family.into_glib(),
                type_.into_glib(),
                protocol_id,
            ))
        }
    }

    /// Looks up the #GType to be used when creating socket connections on
    /// sockets with the specified @family, @type_ and @protocol.
    ///
    /// If no type is registered, the #GSocketConnection base type is returned.
    /// ## `g_type`
    /// a #GType, inheriting from `G_TYPE_SOCKET_CONNECTION`
    /// ## `family`
    /// a #GSocketFamily
    /// ## `type_`
    /// a #GSocketType
    /// ## `protocol`
    /// a protocol id
    #[doc(alias = "g_socket_connection_factory_register_type")]
    pub fn factory_register_type(
        g_type: glib::types::Type,
        family: SocketFamily,
        type_: SocketType,
        protocol: i32,
    ) {
        unsafe {
            ffi::g_socket_connection_factory_register_type(
                g_type.into_glib(),
                family.into_glib(),
                type_.into_glib(),
                protocol,
            );
        }
    }
}

/// Trait containing all [`struct@SocketConnection`] methods.
///
/// # Implementors
///
/// [`SocketConnection`][struct@crate::SocketConnection], [`TcpConnection`][struct@crate::TcpConnection], [`UnixConnection`][struct@crate::UnixConnection]
pub trait SocketConnectionExt: IsA<SocketConnection> + 'static {
    /// Connect @self to the specified remote address.
    /// ## `address`
    /// a #GSocketAddress specifying the remote address.
    /// ## `cancellable`
    /// a `GCancellable` or [`None`]
    ///
    /// # Returns
    ///
    /// [`true`] if the connection succeeded, [`false`] on error
    #[doc(alias = "g_socket_connection_connect")]
    fn connect(
        &self,
        address: &impl IsA<SocketAddress>,
        cancellable: Option<&impl IsA<Cancellable>>,
    ) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_socket_connection_connect(
                self.as_ref().to_glib_none().0,
                address.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                &mut error,
            );
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Asynchronously connect @self to the specified remote address.
    ///
    /// This clears the #GSocket:blocking flag on @self's underlying
    /// socket if it is currently set.
    ///
    /// If #GSocket:timeout is set, the operation will time out and return
    /// [`IOErrorEnum::TimedOut`][crate::IOErrorEnum::TimedOut] after that period. Otherwise, it will continue
    /// indefinitely until operating system timeouts (if any) are hit.
    ///
    /// Use g_socket_connection_connect_finish() to retrieve the result.
    /// ## `address`
    /// a #GSocketAddress specifying the remote address.
    /// ## `cancellable`
    /// a `GCancellable` or [`None`]
    /// ## `callback`
    /// a #GAsyncReadyCallback
    #[doc(alias = "g_socket_connection_connect_async")]
    fn connect_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
        &self,
        address: &impl IsA<SocketAddress>,
        cancellable: Option<&impl IsA<Cancellable>>,
        callback: P,
    ) {
        let main_context = glib::MainContext::ref_thread_default();
        let is_main_context_owner = main_context.is_owner();
        let has_acquired_main_context = (!is_main_context_owner)
            .then(|| main_context.acquire().ok())
            .flatten();
        assert!(
            is_main_context_owner || has_acquired_main_context.is_some(),
            "Async operations only allowed if the thread is owning the MainContext"
        );

        let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
            Box_::new(glib::thread_guard::ThreadGuard::new(callback));
        unsafe extern "C" fn connect_async_trampoline<
            P: FnOnce(Result<(), glib::Error>) + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut crate::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            let mut error = std::ptr::null_mut();
            let _ =
                ffi::g_socket_connection_connect_finish(_source_object as *mut _, res, &mut error);
            let result = if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            };
            let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
                Box_::from_raw(user_data as *mut _);
            let callback: P = callback.into_inner();
            callback(result);
        }
        let callback = connect_async_trampoline::<P>;
        unsafe {
            ffi::g_socket_connection_connect_async(
                self.as_ref().to_glib_none().0,
                address.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    fn connect_future(
        &self,
        address: &(impl IsA<SocketAddress> + Clone + 'static),
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
        let address = address.clone();
        Box_::pin(crate::GioFuture::new(
            self,
            move |obj, cancellable, send| {
                obj.connect_async(&address, Some(cancellable), move |res| {
                    send.resolve(res);
                });
            },
        ))
    }

    /// Try to get the local address of a socket connection.
    ///
    /// # Returns
    ///
    /// a #GSocketAddress or [`None`] on error.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_socket_connection_get_local_address")]
    #[doc(alias = "get_local_address")]
    fn local_address(&self) -> Result<SocketAddress, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_socket_connection_get_local_address(
                self.as_ref().to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Try to get the remote address of a socket connection.
    ///
    /// Since GLib 2.40, when used with g_socket_client_connect() or
    /// g_socket_client_connect_async(), during emission of
    /// [`SocketClientEvent::Connecting`][crate::SocketClientEvent::Connecting], this function will return the remote
    /// address that will be used for the connection.  This allows
    /// applications to print e.g. "Connecting to example.com
    /// (10.42.77.3)...".
    ///
    /// # Returns
    ///
    /// a #GSocketAddress or [`None`] on error.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_socket_connection_get_remote_address")]
    #[doc(alias = "get_remote_address")]
    fn remote_address(&self) -> Result<SocketAddress, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_socket_connection_get_remote_address(
                self.as_ref().to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Gets the underlying #GSocket object of the connection.
    /// This can be useful if you want to do something unusual on it
    /// not supported by the #GSocketConnection APIs.
    ///
    /// # Returns
    ///
    /// a #GSocket or [`None`] on error.
    #[doc(alias = "g_socket_connection_get_socket")]
    #[doc(alias = "get_socket")]
    fn socket(&self) -> Socket {
        unsafe {
            from_glib_none(ffi::g_socket_connection_get_socket(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Checks if @self is connected. This is equivalent to calling
    /// g_socket_is_connected() on @self's underlying #GSocket.
    ///
    /// # Returns
    ///
    /// whether @self is connected
    #[doc(alias = "g_socket_connection_is_connected")]
    fn is_connected(&self) -> bool {
        unsafe {
            from_glib(ffi::g_socket_connection_is_connected(
                self.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<SocketConnection>> SocketConnectionExt for O {}