Struct gio::NetworkMonitor

pub struct NetworkMonitor { /* private fields */ }

NetworkMonitor provides an easy-to-use cross-platform API for monitoring network connectivity. On Linux, the available implementations are based on the kernel’s netlink interface and on NetworkManager.

There is also an implementation for use inside Flatpak sandboxes.

Properties

connectivity

More detailed information about the host’s network connectivity. See NetworkMonitorExt::connectivity() and NetworkConnectivity for more details.

Readable

network-available

Whether the network is considered available. That is, whether the system has a default route for at least one of IPv4 or IPv6.

Real-world networks are of course much more complicated than this; the machine may be connected to a wifi hotspot that requires payment before allowing traffic through, or may be connected to a functioning router that has lost its own upstream connectivity. Some hosts might only be accessible when a VPN is active. Other hosts might only be accessible when the VPN is not active. Thus, it is best to use NetworkMonitorExt::can_reach() or NetworkMonitorExt::can_reach_async() to test for reachability on a host-by-host basis. (On the other hand, when the property is false, the application can reasonably expect that no remote hosts at all are reachable, and should indicate this to the user in its UI.)

See also network-changed.

Readable

network-metered

Whether the network is considered metered.

That is, whether the system has traffic flowing through the default connection that is subject to limitations set by service providers. For example, traffic might be billed by the amount of data transmitted, or there might be a quota on the amount of traffic per month. This is typical with tethered connections (3G and 4G) and in such situations, bandwidth intensive applications may wish to avoid network activity where possible if it will cost the user money or use up their limited quota. Anything more than a few hundreds of kilobytes of data usage per hour should be avoided without asking permission from the user.

If more information is required about specific devices then the system network management API should be used instead (for example, NetworkManager or ConnMan).

If this information is not available then no networks will be marked as metered.

See also network-available.

Readable

Signals

network-changed

Emitted when the network configuration changes.

Implements

NetworkMonitorExt, InitableExt

Implementations

impl NetworkMonitor

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

pub fn default() -> NetworkMonitor

Gets the default NetworkMonitor for the system.

Returns

a NetworkMonitor, which will be a dummy object if no network monitor is available

Trait Implementations

impl Clone for NetworkMonitor

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 NetworkMonitor

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

Formats the value using the given formatter.

impl Display for NetworkMonitor

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

Formats the value using the given formatter.

impl HasParamSpec for NetworkMonitor

type ParamSpec = ParamSpecObject

type SetValue = NetworkMonitor

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for NetworkMonitor

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 NetworkMonitor

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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

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 NetworkMonitor

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 NetworkMonitor

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for NetworkMonitor

impl IsA<Initable> for NetworkMonitor