1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
// 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::AsyncResult;
use crate::Cancellable;
use crate::IOStream;
use crate::Socket;
use crate::SocketAddress;
use crate::SocketFamily;
use crate::SocketType;
use glib::object::IsA;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::pin::Pin;
use std::ptr;

glib::wrapper! {
    /// [`SocketConnection`][crate::SocketConnection] 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 [`SocketConnection`][crate::SocketConnection] 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 3rd 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 [`SocketConnection`][crate::SocketConnection], use [`IOStreamExt::close()`][crate::prelude::IOStreamExt::close()]. Closing both
    /// substreams of the [`IOStream`][crate::IOStream] separately will not close the underlying
    /// [`Socket`][crate::Socket].
    ///
    /// # 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 {
    /// 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 [`SocketConnection`][crate::SocketConnection] base type is returned.
    /// ## `family`
    /// a [`SocketFamily`][crate::SocketFamily]
    /// ## `type_`
    /// a [`SocketType`][crate::SocketType]
    /// ## `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 [`SocketConnection`][crate::SocketConnection] base type is returned.
    /// ## `g_type`
    /// a `GType`, inheriting from `G_TYPE_SOCKET_CONNECTION`
    /// ## `family`
    /// a [`SocketFamily`][crate::SocketFamily]
    /// ## `type_`
    /// a [`SocketType`][crate::SocketType]
    /// ## `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,
            );
        }
    }
}

pub const NONE_SOCKET_CONNECTION: Option<&SocketConnection> = None;

/// Trait containing all [`struct@SocketConnection`] methods.
///
/// # Implementors
///
/// [`SocketConnection`][struct@crate::SocketConnection], [`TcpConnection`][struct@crate::TcpConnection]
pub trait SocketConnectionExt: 'static {
    /// Connect `self` to the specified remote address.
    /// ## `address`
    /// a [`SocketAddress`][crate::SocketAddress] 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<P: IsA<SocketAddress>, Q: IsA<Cancellable>>(
        &self,
        address: &P,
        cancellable: Option<&Q>,
    ) -> Result<(), glib::Error>;

    /// Asynchronously connect `self` to the specified remote address.
    ///
    /// This clears the `property::Socket::blocking` flag on `self`'s underlying
    /// socket if it is currently set.
    ///
    /// Use `g_socket_connection_connect_finish()` to retrieve the result.
    /// ## `address`
    /// a [`SocketAddress`][crate::SocketAddress] specifying the remote address.
    /// ## `cancellable`
    /// a `GCancellable` or [`None`]
    /// ## `callback`
    /// a `GAsyncReadyCallback`
    #[doc(alias = "g_socket_connection_connect_async")]
    fn connect_async<
        P: IsA<SocketAddress>,
        Q: IsA<Cancellable>,
        R: FnOnce(Result<(), glib::Error>) + Send + 'static,
    >(
        &self,
        address: &P,
        cancellable: Option<&Q>,
        callback: R,
    );

    fn connect_async_future<P: IsA<SocketAddress> + Clone + 'static>(
        &self,
        address: &P,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>>;

    /// Try to get the local address of a socket connection.
    ///
    /// # Returns
    ///
    /// a [`SocketAddress`][crate::SocketAddress] 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>;

    /// Try to get the remote address of a socket connection.
    ///
    /// Since GLib 2.40, when used with [`SocketClientExt::connect()`][crate::prelude::SocketClientExt::connect()] or
    /// [`SocketClientExt::connect_async()`][crate::prelude::SocketClientExt::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 [`SocketAddress`][crate::SocketAddress] 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>;

    /// Gets the underlying [`Socket`][crate::Socket] object of the connection.
    /// This can be useful if you want to do something unusual on it
    /// not supported by the [`SocketConnection`][crate::SocketConnection] APIs.
    ///
    /// # Returns
    ///
    /// a [`Socket`][crate::Socket] or [`None`] on error.
    #[doc(alias = "g_socket_connection_get_socket")]
    #[doc(alias = "get_socket")]
    fn socket(&self) -> Socket;

    /// Checks if `self` is connected. This is equivalent to calling
    /// [`SocketExt::is_connected()`][crate::prelude::SocketExt::is_connected()] on `self`'s underlying [`Socket`][crate::Socket].
    ///
    /// # Returns
    ///
    /// whether `self` is connected
    #[doc(alias = "g_socket_connection_is_connected")]
    fn is_connected(&self) -> bool;
}

impl<O: IsA<SocketConnection>> SocketConnectionExt for O {
    fn connect<P: IsA<SocketAddress>, Q: IsA<Cancellable>>(
        &self,
        address: &P,
        cancellable: Option<&Q>,
    ) -> Result<(), glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let _ = 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,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    fn connect_async<
        P: IsA<SocketAddress>,
        Q: IsA<Cancellable>,
        R: FnOnce(Result<(), glib::Error>) + Send + 'static,
    >(
        &self,
        address: &P,
        cancellable: Option<&Q>,
        callback: R,
    ) {
        let user_data: Box_<R> = Box_::new(callback);
        unsafe extern "C" fn connect_async_trampoline<
            R: FnOnce(Result<(), glib::Error>) + Send + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut crate::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            let mut error = 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_<R> = Box_::from_raw(user_data as *mut _);
            callback(result);
        }
        let callback = connect_async_trampoline::<R>;
        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_async_future<P: IsA<SocketAddress> + Clone + 'static>(
        &self,
        address: &P,
    ) -> 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);
                });
            },
        ))
    }

    fn local_address(&self) -> Result<SocketAddress, glib::Error> {
        unsafe {
            let mut error = 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))
            }
        }
    }

    fn remote_address(&self) -> Result<SocketAddress, glib::Error> {
        unsafe {
            let mut error = 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))
            }
        }
    }

    fn socket(&self) -> Socket {
        unsafe {
            from_glib_none(ffi::g_socket_connection_get_socket(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn is_connected(&self) -> bool {
        unsafe {
            from_glib(ffi::g_socket_connection_is_connected(
                self.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl fmt::Display for SocketConnection {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("SocketConnection")
    }
}