GI.Gio.Interfaces.NetworkMonitor

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.

Since: 2.32

Exported types

newtype NetworkMonitor

Memory-managed wrapper type.

Constructors

NetworkMonitor (ManagedPtr NetworkMonitor)

Instances

Eq NetworkMonitor

Defined in GI.Gio.Interfaces.NetworkMonitor

Methods

(==) :: NetworkMonitor -> NetworkMonitor -> Bool

(/=) :: NetworkMonitor -> NetworkMonitor -> Bool

GObject NetworkMonitor

Defined in GI.Gio.Interfaces.NetworkMonitor

ManagedPtrNewtype NetworkMonitor

Defined in GI.Gio.Interfaces.NetworkMonitor

Methods

toManagedPtr :: NetworkMonitor -> ManagedPtr NetworkMonitor

TypedObject NetworkMonitor

Defined in GI.Gio.Interfaces.NetworkMonitor

Methods

glibType :: IO GType

HasParentTypes NetworkMonitor

Defined in GI.Gio.Interfaces.NetworkMonitor

IsGValue (Maybe NetworkMonitor)

Convert NetworkMonitor to and from GValue. See toGValue and fromGValue.

Defined in GI.Gio.Interfaces.NetworkMonitor

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe NetworkMonitor -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe NetworkMonitor)

type ParentTypes NetworkMonitor

Defined in GI.Gio.Interfaces.NetworkMonitor

type ParentTypes NetworkMonitor = '[Initable, Object]

class (GObject o, IsDescendantOf NetworkMonitor o) => IsNetworkMonitor o

Type class for types which can be safely cast to NetworkMonitor, for instance with toNetworkMonitor.

Instances

(GObject o, IsDescendantOf NetworkMonitor o) => IsNetworkMonitor o

Defined in GI.Gio.Interfaces.NetworkMonitor

toNetworkMonitor :: (MonadIO m, IsNetworkMonitor o) => o -> m NetworkMonitor

Cast to NetworkMonitor, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, canReach, canReachAsync, canReachFinish, forceFloating, freezeNotify, getv, init, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getConnectivity, getData, getNetworkAvailable, getNetworkMetered, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

canReach

networkMonitorCanReach

Arguments

:: (HasCallStack, MonadIO m, IsNetworkMonitor a, IsSocketConnectable b, IsCancellable c)

=> a

monitor: a NetworkMonitor

-> b

connectable: a SocketConnectable

-> Maybe c

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Attempts to determine whether or not the host pointed to by connectable can be reached, without actually trying to connect to it.

This may return True even when NetworkMonitor:network-available is False, if, for example, monitor can determine that connectable refers to a host on a local network.

If monitor believes that an attempt to connect to connectable will succeed, it will return True. Otherwise, it will return False and set error to an appropriate error (such as IOErrorEnumHostUnreachable).

Note that although this does not attempt to connect to connectable, it may still block for a brief period of time (eg, trying to do multicast DNS on the local network), so if you do not want to block, you should use networkMonitorCanReachAsync.

Since: 2.32

canReachAsync

networkMonitorCanReachAsync

Arguments

:: (HasCallStack, MonadIO m, IsNetworkMonitor a, IsSocketConnectable b, IsCancellable c)

=> a

monitor: a NetworkMonitor

-> b

connectable: a SocketConnectable

-> Maybe c

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously attempts to determine whether or not the host pointed to by connectable can be reached, without actually trying to connect to it.

For more details, see networkMonitorCanReach.

When the operation is finished, callback will be called. You can then call networkMonitorCanReachFinish to get the result of the operation.

canReachFinish

networkMonitorCanReachFinish

Arguments

:: (HasCallStack, MonadIO m, IsNetworkMonitor a, IsAsyncResult b)

=> a

monitor: a NetworkMonitor

-> b

result: a AsyncResult

-> m ()

(Can throw GError)

Finishes an async network connectivity test. See networkMonitorCanReachAsync.

getConnectivity

networkMonitorGetConnectivity

Arguments

:: (HasCallStack, MonadIO m, IsNetworkMonitor a)

=> a

monitor: the NetworkMonitor

-> m NetworkConnectivity

Returns: the network connectivity state

Gets a more detailed networking state than networkMonitorGetNetworkAvailable.

If NetworkMonitor:network-available is False, then the connectivity state will be NetworkConnectivityLocal.

If NetworkMonitor:network-available is True, then the connectivity state will be NetworkConnectivityFull (if there is full Internet connectivity), NetworkConnectivityLimited (if the host has a default route, but appears to be unable to actually reach the full Internet), or NetworkConnectivityPortal (if the host is trapped behind a "captive portal" that requires some sort of login or acknowledgement before allowing full Internet access).

Note that in the case of NetworkConnectivityLimited and NetworkConnectivityPortal, it is possible that some sites are reachable but others are not. In this case, applications can attempt to connect to remote servers, but should gracefully fall back to their "offline" behavior if the connection attempt fails.

Since: 2.44

getDefault

networkMonitorGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m NetworkMonitor

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

Gets the default NetworkMonitor for the system.

Since: 2.32

getNetworkAvailable

networkMonitorGetNetworkAvailable

Arguments

:: (HasCallStack, MonadIO m, IsNetworkMonitor a)

=> a

monitor: the NetworkMonitor

-> m Bool

Returns: whether the network is available

Checks if the network is available. "Available" here means that the system has a default route available for at least one of IPv4 or IPv6. It does not necessarily imply that the public Internet is reachable. See NetworkMonitor:network-available for more details.

Since: 2.32

getNetworkMetered

networkMonitorGetNetworkMetered

Arguments

:: (HasCallStack, MonadIO m, IsNetworkMonitor a)

=> a

monitor: the NetworkMonitor

-> m Bool

Returns: whether the connection is metered

Checks if the network is metered. See NetworkMonitor:network-metered for more details.

Since: 2.46

Properties

connectivity

More detailed information about the host's network connectivity. See networkMonitorGetConnectivity and NetworkConnectivity for more details.

Since: 2.44

getNetworkMonitorConnectivity :: (MonadIO m, IsNetworkMonitor o) => o -> m NetworkConnectivity

Get the value of the “connectivity” property. When overloading is enabled, this is equivalent to

get networkMonitor #connectivity

networkAvailable

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 networkMonitorCanReach or networkMonitorCanReachAsync 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 NetworkMonitor::networkChanged.

Since: 2.32

getNetworkMonitorNetworkAvailable :: (MonadIO m, IsNetworkMonitor o) => o -> m Bool

Get the value of the “network-available” property. When overloading is enabled, this is equivalent to

get networkMonitor #networkAvailable

networkMetered

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.

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 NetworkMonitor:network-available.

Since: 2.46

getNetworkMonitorNetworkMetered :: (MonadIO m, IsNetworkMonitor o) => o -> m Bool

Get the value of the “network-metered” property. When overloading is enabled, this is equivalent to

get networkMonitor #networkMetered

Signals

networkChanged

type NetworkMonitorNetworkChangedCallback

Arguments

 = Bool

networkAvailable: the current value of NetworkMonitor:network-available

-> IO ()

Emitted when the network configuration changes.

Since: 2.32

afterNetworkMonitorNetworkChanged :: (IsNetworkMonitor a, MonadIO m) => a -> ((?self :: a) => NetworkMonitorNetworkChangedCallback) -> m SignalHandlerId

Connect a signal handler for the networkChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after networkMonitor #networkChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onNetworkMonitorNetworkChanged :: (IsNetworkMonitor a, MonadIO m) => a -> ((?self :: a) => NetworkMonitorNetworkChangedCallback) -> m SignalHandlerId

Connect a signal handler for the networkChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on networkMonitor #networkChanged callback