GI.NM.Interfaces.Connection

NMConnection is the interface implemented by RemoteConnection on the client side, and NMSettingsConnection on the daemon side.

Exported types

newtype Connection

Memory-managed wrapper type.

Constructors

Connection (ManagedPtr Connection)

Instances

Eq Connection

Defined in GI.NM.Interfaces.Connection

Methods

(==) :: Connection -> Connection -> Bool

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

GObject Connection

Defined in GI.NM.Interfaces.Connection

ManagedPtrNewtype Connection

Defined in GI.NM.Interfaces.Connection

Methods

toManagedPtr :: Connection -> ManagedPtr Connection

TypedObject Connection

Defined in GI.NM.Interfaces.Connection

Methods

glibType :: IO GType

HasParentTypes Connection

Defined in GI.NM.Interfaces.Connection

IsGValue (Maybe Connection)

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

Defined in GI.NM.Interfaces.Connection

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Connection

Defined in GI.NM.Interfaces.Connection

type ParentTypes Connection = '[Object]

class (GObject o, IsDescendantOf Connection o) => IsConnection o

Type class for types which can be safely cast to Connection, for instance with toConnection.

Instances

(GObject o, IsDescendantOf Connection o) => IsConnection o

Defined in GI.NM.Interfaces.Connection

toConnection :: (MonadIO m, IsConnection o) => o -> m Connection

Cast to Connection, 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

addSetting, bindProperty, bindPropertyFull, clearSecrets, clearSecretsWithFlags, clearSettings, compare, dump, forEachSettingValue, forceFloating, freezeNotify, getv, isFloating, isType, isVirtual, needSecrets, normalize, notify, notifyByPspec, ref, refSink, removeSetting, replaceSettings, replaceSettingsFromConnection, runDispose, stealData, stealQdata, thawNotify, toDbus, unref, updateSecrets, verify, verifySecrets, watchClosure.

Getters

getConnectionType, getData, getId, getInterfaceName, getPath, getProperty, getQdata, getSetting, getSetting8021x, getSettingAdsl, getSettingBluetooth, getSettingBond, getSettingBridge, getSettingBridgePort, getSettingByName, getSettingCdma, getSettingConnection, getSettingDcb, getSettingDummy, getSettingGeneric, getSettingGsm, getSettingInfiniband, getSettingIp4Config, getSettingIp6Config, getSettingIpTunnel, getSettingMacsec, getSettingMacvlan, getSettingOlpcMesh, getSettingOvsBridge, getSettingOvsInterface, getSettingOvsPatch, getSettingOvsPort, getSettingPpp, getSettingPppoe, getSettingProxy, getSettingSerial, getSettingTcConfig, getSettingTeam, getSettingTeamPort, getSettingTun, getSettingVlan, getSettingVpn, getSettingVxlan, getSettingWimax, getSettingWired, getSettingWireless, getSettingWirelessSecurity, getSettings, getUuid, getVirtualDeviceDescription.

Setters

setData, setDataFull, setPath, setProperty.

addSetting

connectionAddSetting

Arguments

:: (HasCallStack, MonadIO m, IsConnection a, IsSetting b)

=> a

connection: a Connection

-> b

setting: the Setting to add to the connection object

-> m ()

Adds a Setting to the connection, replacing any previous Setting of the same name which has previously been added to the Connection. The connection takes ownership of the Setting object and does not increase the setting object's reference count.

clearSecrets

connectionClearSecrets

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m ()

Clears and frees any secrets that may be stored in the connection, to avoid keeping secret data in memory when not needed.

clearSecretsWithFlags

connectionClearSecretsWithFlags

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> Maybe SettingClearSecretsWithFlagsFn

func: function to be called to determine whether a specific secret should be cleared or not. If Nothing, all secrets are cleared.

-> m ()

Clears and frees secrets determined by func.

clearSettings

connectionClearSettings

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: a Connection

-> m ()

Deletes all of connection's settings.

compare

connectionCompare

Arguments

:: (HasCallStack, MonadIO m, IsConnection a, IsConnection b)

=> a

a: a Connection

-> b

b: a second Connection to compare with the first

-> SettingCompareFlags

flags: compare flags, e.g. SettingCompareFlagsExact

-> m Bool

Returns: True if the comparison succeeds, False if it does not

Compares two Connection objects for similarity, with comparison behavior modified by a set of flags. See settingCompare for a description of each flag's behavior.

dump

connectionDump

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m ()

Print the connection (including secrets!) to stdout. For debugging purposes ONLY, should NOT be used for serialization of the setting, or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.

forEachSettingValue

connectionForEachSettingValue

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> SettingValueIterFn

func: user-supplied function called for each setting's property

-> m ()

Iterates over the properties of each Setting object in the Connection, calling the supplied user function for each property.

getConnectionType

connectionGetConnectionType

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m Text

Returns: the type from the connection's 'connection' setting

A shortcut to return the type from the connection's SettingConnection.

getId

connectionGetId

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m Text

Returns: the ID from the connection's 'connection' setting

A shortcut to return the ID from the connection's SettingConnection.

getInterfaceName

connectionGetInterfaceName

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: The Connection

-> m Text

Returns: Name of the kernel interface or Nothing

Returns the interface name as stored in NMSettingConnection:interface_name. If the connection contains no NMSettingConnection, it will return Nothing.

For hardware devices and software devices created outside of NetworkManager, this name is used to match the device. for software devices created by NetworkManager, this is the name of the created interface.

getPath

connectionGetPath

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m Text

Returns: the D-Bus path of the connection, previously set by a call to connectionSetPath.

Returns the connection's D-Bus path.

getSetting

connectionGetSetting

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: a Connection

-> GType

settingType: the GType of the setting object to return

-> m Setting

Returns: the Setting, or Nothing if no setting of that type was previously added to the Connection

Gets the Setting with the given GType, if one has been previously added to the Connection.

getSetting8021x

connectionGetSetting8021x

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m Setting8021x

Returns: an Setting8021x if the connection contains one, otherwise Nothing

A shortcut to return any Setting8021x the connection might contain.

getSettingAdsl

connectionGetSettingAdsl

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingAdsl

Returns: an SettingAdsl if the connection contains one, otherwise Nothing

A shortcut to return any SettingAdsl the connection might contain.

getSettingBluetooth

connectionGetSettingBluetooth

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingBluetooth

Returns: an SettingBluetooth if the connection contains one, otherwise Nothing

A shortcut to return any SettingBluetooth the connection might contain.

getSettingBond

connectionGetSettingBond

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingBond

Returns: an SettingBond if the connection contains one, otherwise Nothing

A shortcut to return any SettingBond the connection might contain.

getSettingBridge

connectionGetSettingBridge

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingBridge

Returns: an SettingBridge if the connection contains one, otherwise Nothing

A shortcut to return any SettingBridge the connection might contain.

getSettingBridgePort

connectionGetSettingBridgePort

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingBridgePort

Returns: an SettingBridgePort if the connection contains one, otherwise Nothing

A shortcut to return any SettingBridgePort the connection might contain.

getSettingByName

connectionGetSettingByName

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: a Connection

-> Text

name: a setting name

-> m Setting

Returns: the Setting, or Nothing if no setting with that name was previously added to the Connection

Gets the Setting with the given name, if one has been previously added the Connection.

getSettingCdma

connectionGetSettingCdma

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingCdma

Returns: an SettingCdma if the connection contains one, otherwise Nothing

A shortcut to return any SettingCdma the connection might contain.

getSettingConnection

connectionGetSettingConnection

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingConnection

Returns: an SettingConnection if the connection contains one, otherwise Nothing

A shortcut to return any SettingConnection the connection might contain.

getSettingDcb

connectionGetSettingDcb

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingDcb

Returns: an SettingDcb if the connection contains one, otherwise NULL

A shortcut to return any SettingDcb the connection might contain.

getSettingDummy

connectionGetSettingDummy

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingDummy

Returns: an SettingDummy if the connection contains one, otherwise Nothing

A shortcut to return any SettingDummy the connection might contain.

Since: 1.8

getSettingGeneric

connectionGetSettingGeneric

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingGeneric

Returns: an SettingGeneric if the connection contains one, otherwise NULL

A shortcut to return any SettingGeneric the connection might contain.

getSettingGsm

connectionGetSettingGsm

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingGsm

Returns: an SettingGsm if the connection contains one, otherwise Nothing

A shortcut to return any SettingGsm the connection might contain.

getSettingInfiniband

connectionGetSettingInfiniband

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingInfiniband

Returns: an SettingInfiniband if the connection contains one, otherwise Nothing

A shortcut to return any SettingInfiniband the connection might contain.

getSettingIp4Config

connectionGetSettingIp4Config

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingIP4Config

Returns: an SettingIP4Config if the connection contains one, otherwise Nothing

A shortcut to return any SettingIP4Config the connection might contain.

Note that it returns the value as type SettingIPConfig, since the vast majority of IPv4-setting-related methods are on that type, not SettingIP4Config.

getSettingIp6Config

connectionGetSettingIp6Config

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingIP6Config

Returns: an SettingIP6Config if the connection contains one, otherwise Nothing

A shortcut to return any SettingIP6Config the connection might contain.

Note that it returns the value as type SettingIPConfig, since the vast majority of IPv6-setting-related methods are on that type, not SettingIP6Config.

getSettingIpTunnel

connectionGetSettingIpTunnel

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingIPTunnel

Returns: an SettingIPTunnel if the connection contains one, otherwise Nothing

A shortcut to return any SettingIPTunnel the connection might contain.

Since: 1.2

getSettingMacsec

connectionGetSettingMacsec

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingMacsec

Returns: an SettingMacsec if the connection contains one, otherwise Nothing

A shortcut to return any SettingMacsec the connection might contain.

Since: 1.6

getSettingMacvlan

connectionGetSettingMacvlan

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingMacvlan

Returns: an SettingMacvlan if the connection contains one, otherwise Nothing

A shortcut to return any SettingMacvlan the connection might contain.

Since: 1.2

getSettingOlpcMesh

connectionGetSettingOlpcMesh

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingOlpcMesh

Returns: an SettingOlpcMesh if the connection contains one, otherwise Nothing

A shortcut to return any SettingOlpcMesh the connection might contain.

getSettingOvsBridge

connectionGetSettingOvsBridge

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingOvsBridge

Returns: an SettingOvsBridge if the connection contains one, otherwise Nothing

A shortcut to return any SettingOvsBridge the connection might contain.

Since: 1.14

getSettingOvsInterface

connectionGetSettingOvsInterface

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingOvsInterface

Returns: an SettingOvsInterface if the connection contains one, otherwise Nothing

A shortcut to return any SettingOvsInterface the connection might contain.

Since: 1.14

getSettingOvsPatch

connectionGetSettingOvsPatch

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingOvsPatch

Returns: an SettingOvsPatch if the connection contains one, otherwise Nothing

A shortcut to return any SettingOvsPatch the connection might contain.

Since: 1.14

getSettingOvsPort

connectionGetSettingOvsPort

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingOvsPort

Returns: an SettingOvsPort if the connection contains one, otherwise Nothing

A shortcut to return any SettingOvsPort the connection might contain.

Since: 1.14

getSettingPpp

connectionGetSettingPpp

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingPpp

Returns: an SettingPpp if the connection contains one, otherwise Nothing

A shortcut to return any SettingPpp the connection might contain.

getSettingPppoe

connectionGetSettingPppoe

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingPppoe

Returns: an SettingPppoe if the connection contains one, otherwise Nothing

A shortcut to return any SettingPppoe the connection might contain.

getSettingProxy

connectionGetSettingProxy

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingProxy

Returns: an SettingProxy if the connection contains one, otherwise Nothing

A shortcut to return any SettingProxy the connection might contain.

Since: 1.6

getSettingSerial

connectionGetSettingSerial

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingSerial

Returns: an SettingSerial if the connection contains one, otherwise Nothing

A shortcut to return any SettingSerial the connection might contain.

getSettingTcConfig

connectionGetSettingTcConfig

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingTCConfig

Returns: an SettingTCConfig if the connection contains one, otherwise Nothing

A shortcut to return any SettingTCConfig the connection might contain.

Since: 1.12

getSettingTeam

connectionGetSettingTeam

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingTeam

Returns: an SettingTeam if the connection contains one, otherwise Nothing

A shortcut to return any SettingTeam the connection might contain.

getSettingTeamPort

connectionGetSettingTeamPort

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingTeamPort

Returns: an SettingTeamPort if the connection contains one, otherwise Nothing

A shortcut to return any SettingTeamPort the connection might contain.

getSettingTun

connectionGetSettingTun

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingTun

Returns: an SettingTun if the connection contains one, otherwise Nothing

A shortcut to return any SettingTun the connection might contain.

Since: 1.14

getSettingVlan

connectionGetSettingVlan

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingVlan

Returns: an SettingVlan if the connection contains one, otherwise Nothing

A shortcut to return any SettingVlan the connection might contain.

getSettingVpn

connectionGetSettingVpn

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingVpn

Returns: an SettingVpn if the connection contains one, otherwise Nothing

A shortcut to return any SettingVpn the connection might contain.

getSettingVxlan

connectionGetSettingVxlan

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingVxlan

Returns: an SettingVxlan if the connection contains one, otherwise Nothing

A shortcut to return any SettingVxlan the connection might contain.

Since: 1.2

getSettingWimax

connectionGetSettingWimax

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingWimax

Returns: an SettingWimax if the connection contains one, otherwise Nothing

A shortcut to return any SettingWimax the connection might contain.

getSettingWired

connectionGetSettingWired

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingWired

Returns: an SettingWired if the connection contains one, otherwise Nothing

A shortcut to return any SettingWired the connection might contain.

getSettingWireless

connectionGetSettingWireless

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingWireless

Returns: an SettingWireless if the connection contains one, otherwise Nothing

A shortcut to return any SettingWireless the connection might contain.

getSettingWirelessSecurity

connectionGetSettingWirelessSecurity

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m SettingWirelessSecurity

Returns: an SettingWirelessSecurity if the connection contains one, otherwise Nothing

A shortcut to return any SettingWirelessSecurity the connection might contain.

getSettings

connectionGetSettings

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection instance

-> m (Maybe [Setting])

Returns: a Nothing-terminated array containing every setting of connection. If the connection has no settings, Nothing is returned.

Retrieves the settings in connection.

The returned array is Nothing-terminated.

Since: 1.10

getUuid

connectionGetUuid

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m Text

Returns: the UUID from the connection's 'connection' setting

A shortcut to return the UUID from the connection's SettingConnection.

getVirtualDeviceDescription

connectionGetVirtualDeviceDescription

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: an Connection for a virtual device type

-> m Text

Returns: the name of connection's device, or Nothing if connection is not a virtual connection type

Returns the name that deviceDisambiguateNames would return for the virtual device that would be created for connection. Eg, "VLAN (eth1.1)".

isType

connectionIsType

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> Text

type: a setting name to check the connection's type against (like SETTING_WIRELESS_SETTING_NAME or SETTING_WIRED_SETTING_NAME)

-> m Bool

Returns: True if the connection is of the given type, False if not

A convenience function to check if the given connection is a particular type (ie wired, Wi-Fi, ppp, etc). Checks the SettingConnection:type property of the connection and matches that against type.

isVirtual

connectionIsVirtual

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: an Connection

-> m Bool

Returns: whether connection refers to a virtual device

Checks if connection refers to a virtual device (and thus can potentially be activated even if the device it refers to doesn't exist).

needSecrets

connectionNeedSecrets

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> m (Maybe Text, Maybe [Text])

Returns: the setting name of the Setting object which has invalid or missing secrets

Returns the name of the first setting object in the connection which would need secrets to make a successful connection. The returned hints are only intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which secrets are needed.

normalize

connectionNormalize

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection to normalize

-> Maybe (Map Text (Ptr ()))

parameters: a HashTable with normalization parameters to allow customization of the normalization by providing specific arguments. Unknown arguments will be ignored and the default will be used. The keys must be strings compared with strEqual function. The values are opaque and depend on the parameter name.

-> m Bool

(Can throw GError)

Does some basic normalization and fixup of well known inconsistencies and deprecated fields. If the connection was modified in any way, the output parameter modified is set True.

Finally the connection will be verified and True returns if the connection is valid. As this function only performs some specific normalization steps it cannot repair all connections. If the connection has errors that cannot be normalized, the connection will not be modified.

removeSetting

connectionRemoveSetting

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: a Connection

-> GType

settingType: the GType of the setting object to remove

-> m ()

Removes the Setting with the given GType from the Connection. This operation dereferences the Setting object.

replaceSettings

connectionReplaceSettings

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: a Connection

-> GVariant

newSettings: a GVariant of type NM_VARIANT_TYPE_CONNECTION, with the new settings

-> m ()

(Can throw GError)

Replaces connection's settings with newSettings (which must be syntactically valid, and describe a known type of connection, but does not need to result in a connection that passes connectionVerify).

replaceSettingsFromConnection

connectionReplaceSettingsFromConnection

Arguments

:: (HasCallStack, MonadIO m, IsConnection a, IsConnection b)

=> a

connection: a Connection

-> b

newConnection: a Connection to replace the settings of connection with

-> m ()

Deep-copies the settings of newConnection and replaces the settings of connection with the copied settings.

setPath

connectionSetPath

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> Text

path: the D-Bus path of the connection as given by the settings service which provides the connection

-> m ()

Sets the D-Bus path of the connection. This property is not serialized, and is only for the reference of the caller. Sets the Connection:path property.

toDbus

connectionToDbus

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> [ConnectionSerializationFlags]

flags: serialization flags, e.g. ConnectionSerializationFlagsAll

-> m GVariant

Returns: a new floating GVariant describing the connection, its settings, and each setting's properties.

Converts the Connection into a GVariant of type NM_VARIANT_TYPE_CONNECTION describing the connection, suitable for marshalling over D-Bus or otherwise serializing.

updateSecrets

connectionUpdateSecrets

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection

-> Text

settingName: the setting object name to which the secrets apply

-> GVariant

secrets: a GVariant of secrets, of type NM_VARIANT_TYPE_CONNECTION or NM_VARIANT_TYPE_SETTING

-> m ()

(Can throw GError)

Update the specified setting's secrets, given a dictionary of secrets intended for that setting (deserialized from D-Bus for example). Will also extract the given setting's secrets hash if given a connection dictionary. If settingName is Nothing, expects a fully serialized Connection as returned by connectionToDbus and will update all secrets from all settings contained in secrets.

verify

connectionVerify

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection to verify

-> m ()

(Can throw GError)

Validates the connection and all its settings. Each setting's properties have allowed values, and some values are dependent on other values. For example, if a Wi-Fi connection is security enabled, the SettingWireless setting object's 'security' property must contain the setting name of the SettingWirelessSecurity object, which must also be present in the connection for the connection to be valid. As another example, the SettingWired object's 'mac-address' property must be a validly formatted MAC address. The returned GError contains information about which setting and which property failed validation, and how it failed validation.

verifySecrets

connectionVerifySecrets

Arguments

:: (HasCallStack, MonadIO m, IsConnection a)

=> a

connection: the Connection to verify in

-> m ()

(Can throw GError)

Verifies the secrets in the connection.

Since: 1.2

Signals

changed

type ConnectionChangedCallback = IO ()

The changed signal is emitted when any property (including secrets) of any setting of the connection is modified, or when settings are added or removed.

afterConnectionChanged :: (IsConnection a, MonadIO m) => a -> ((?self :: a) => ConnectionChangedCallback) -> m SignalHandlerId

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

after connection #changed 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.

onConnectionChanged :: (IsConnection a, MonadIO m) => a -> ((?self :: a) => ConnectionChangedCallback) -> m SignalHandlerId

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

on connection #changed callback

secretsCleared

type ConnectionSecretsClearedCallback = IO ()

The secretsCleared signal is emitted when the secrets of a connection are cleared.

afterConnectionSecretsCleared :: (IsConnection a, MonadIO m) => a -> ((?self :: a) => ConnectionSecretsClearedCallback) -> m SignalHandlerId

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

after connection #secretsCleared 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.

onConnectionSecretsCleared :: (IsConnection a, MonadIO m) => a -> ((?self :: a) => ConnectionSecretsClearedCallback) -> m SignalHandlerId

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

on connection #secretsCleared callback

secretsUpdated

type ConnectionSecretsUpdatedCallback

Arguments

 = Text

settingName: the setting name of the Setting for which secrets were updated

-> IO ()

The secretsUpdated signal is emitted when the secrets of a setting have been changed.

afterConnectionSecretsUpdated :: (IsConnection a, MonadIO m) => a -> ((?self :: a) => ConnectionSecretsUpdatedCallback) -> m SignalHandlerId

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

after connection #secretsUpdated 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.

onConnectionSecretsUpdated :: (IsConnection a, MonadIO m) => a -> ((?self :: a) => ConnectionSecretsUpdatedCallback) -> m SignalHandlerId

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

on connection #secretsUpdated callback