Struct gio::SocketClient

#[repr(transparent)]
pub struct SocketClient { /* private fields */ }

SocketClient is a lightweight high-level utility class for connecting to a network host using a connection oriented socket type.

You create a SocketClient object, set any options you want, and then call a sync or async connect operation, which returns a SocketConnection subclass on success.

The type of the SocketConnection object returned depends on the type of the underlying socket that is in use. For instance, for a TCP/IP connection it will be a TcpConnection.

As SocketClient is a lightweight object, you don’t need to cache it. You can just create a new one any time you need one.

Properties

enable-proxy

Readable | Writeable | Construct

family

Readable | Writeable | Construct

local-address

Readable | Writeable | Construct

protocol

Readable | Writeable | Construct

proxy-resolver

The proxy resolver to use

Readable | Writeable | Construct

timeout

Readable | Writeable | Construct

tls

Readable | Writeable | Construct

tls-validation-flags

The TLS validation flags used when creating TLS connections. The default value is TlsCertificateFlags::VALIDATE_ALL.

GLib guarantees that if certificate verification fails, at least one flag will be set, but it does not guarantee that all possible flags will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to mask TlsCertificateFlags::EXPIRED if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the certificate. Therefore, there is no safe way to use this property. This is not a horrible problem, though, because you should not be attempting to ignore validation errors anyway. If you really must ignore TLS certificate errors, connect to the event signal, wait for it to be emitted with SocketClientEvent::TlsHandshaking, and use that to connect to accept-certificate.

Readable | Writeable | Construct

type

Readable | Writeable | Construct

Signals

event

Emitted when client’s activity on connectable changes state. Among other things, this can be used to provide progress information about a network connection in the UI. The meanings of the different event values are as follows:

• SocketClientEvent::Resolving: client is about to look up connectable in DNS. connection will be None.

• SocketClientEvent::Resolved: client has successfully resolved connectable in DNS. connection will be None.

• SocketClientEvent::Connecting: client is about to make a connection to a remote host; either a proxy server or the destination server itself. connection is the SocketConnection, which is not yet connected. Since GLib 2.40, you can access the remote address via SocketConnectionExt::remote_address().

• SocketClientEvent::Connected: client has successfully connected to a remote host. connection is the connected SocketConnection.

• SocketClientEvent::ProxyNegotiating: client is about to negotiate with a proxy to get it to connect to connectable. connection is the SocketConnection to the proxy server.

• SocketClientEvent::ProxyNegotiated: client has negotiated a connection to connectable through a proxy server. connection is the stream returned from ProxyExt::connect(), which may or may not be a SocketConnection.

• SocketClientEvent::TlsHandshaking: client is about to begin a TLS handshake. connection is a TlsClientConnection.

• SocketClientEvent::TlsHandshaked: client has successfully completed the TLS handshake. connection is a TlsClientConnection.

• SocketClientEvent::Complete: client has either successfully connected to connectable (in which case connection is the SocketConnection that it will be returning to the caller) or has failed (in which case connection is None and the client is about to return an error).

Each event except SocketClientEvent::Complete may be emitted multiple times (or not at all) for a given connectable (in particular, if client ends up attempting to connect to more than one address). However, if client emits the event signal at all for a given connectable, then it will always emit it with SocketClientEvent::Complete when it is done.

Note that there may be additional SocketClientEvent values in the future; unrecognized event values should be ignored.

Implements

SocketClientExt, glib::ObjectExt

Implementations

impl SocketClient

pub const NONE: Option<&'static SocketClient> = None

pub fn new() -> SocketClient

Creates a new SocketClient with the default options.

Returns

a SocketClient. Free the returned object with g_object_unref().

Trait Implementations

impl Clone for SocketClient

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SocketClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SocketClient

fn default() -> Self

Returns the “default value” for a type.

impl Display for SocketClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for SocketClient

type ParamSpec = ParamSpecObject

type SetValue = SocketClient

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SocketClient>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SocketClient

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SocketClient

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for SocketClient

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for SocketClient

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SocketClient

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SocketClient

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SocketClient