gio/org.gtkkn.bindings.gio/NetworkMonitor

NetworkMonitor

GNetworkMonitor 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

Types

Companion

object Companion

Properties

connectivity

open val connectivity: NetworkConnectivity

More detailed information about the host's network connectivity. See g_network_monitor_get_connectivity() and #GNetworkConnectivity for more details.

gioInitablePointer

open override val gioInitablePointer: <Error class: unknown class><<Error class: unknown class>>

gioNetworkMonitorPointer

abstract val gioNetworkMonitorPointer: <Error class: unknown class><<Error class: unknown class>>

networkAvailable

open val networkAvailable: Boolean

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

networkMetered

open val networkMetered: Boolean

Whether the network is considered metered.

Functions

canReach

open fun canReach(connectable: SocketConnectable, cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Attempts to determine whether or not the host pointed to by

canReachAsync

open fun canReachAsync(connectable: SocketConnectable, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

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

canReachFinish

open fun canReachFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes an async network connectivity test. See g_network_monitor_can_reach_async().

connectNetworkChanged

open fun connectNetworkChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (networkAvailable: Boolean) -> Unit): <Error class: unknown class>

Emitted when the network configuration changes.

getConnectivity

open fun getConnectivity(): NetworkConnectivity

Gets a more detailed networking state than g_network_monitor_get_network_available().

getNetworkAvailable

open fun getNetworkAvailable(): Boolean

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 #GNetworkMonitor:network-available for more details.

getNetworkMetered

open fun getNetworkMetered(): Boolean

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

init

open fun init(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Initializes the object implementing the interface.