From 88625ab09bf9c6d8f0d5042fcde398a5abfd1da6 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 17 May 2024 11:38:51 +0200 Subject: New upstream version 1.47.91 --- docs/libnm/html/NMSettingWireGuard.html | 170 ++++++++++++++++---------------- 1 file changed, 85 insertions(+), 85 deletions(-) (limited to 'docs/libnm/html/NMSettingWireGuard.html') diff --git a/docs/libnm/html/NMSettingWireGuard.html b/docs/libnm/html/NMSettingWireGuard.html index c1cd54d1..2dbeb3b4 100644 --- a/docs/libnm/html/NMSettingWireGuard.html +++ b/docs/libnm/html/NMSettingWireGuard.html @@ -8,7 +8,7 @@ - + @@ -82,7 +82,7 @@ -gboolean +gboolean nm_wireguard_peer_is_sealed () @@ -97,7 +97,7 @@ -gboolean +gboolean nm_wireguard_peer_set_public_key () @@ -112,7 +112,7 @@ -gboolean +gboolean nm_wireguard_peer_set_preshared_key () @@ -136,7 +136,7 @@ -guint16 +guint16 nm_wireguard_peer_get_persistent_keepalive () @@ -159,7 +159,7 @@ -gboolean +gboolean nm_wireguard_peer_set_endpoint () @@ -167,7 +167,7 @@ -guint +guint nm_wireguard_peer_get_allowed_ips_len () @@ -190,7 +190,7 @@ -gboolean +gboolean nm_wireguard_peer_append_allowed_ip () @@ -198,7 +198,7 @@ -gboolean +gboolean nm_wireguard_peer_remove_allowed_ip () @@ -206,7 +206,7 @@ -gboolean +gboolean nm_wireguard_peer_is_valid () @@ -245,7 +245,7 @@ -guint16 +guint16 nm_setting_wireguard_get_listen_port () @@ -253,7 +253,7 @@ -guint32 +guint32 nm_setting_wireguard_get_fwmark () @@ -261,7 +261,7 @@ -guint +guint nm_setting_wireguard_get_peers_len () @@ -301,7 +301,7 @@ -gboolean +gboolean nm_setting_wireguard_remove_peer () @@ -309,7 +309,7 @@ -guint +guint nm_setting_wireguard_clear_peers () @@ -317,7 +317,7 @@ -gboolean +gboolean nm_setting_wireguard_get_peer_routes () @@ -325,7 +325,7 @@ -guint32 +guint32 nm_setting_wireguard_get_mtu () @@ -462,7 +462,7 @@ nm_wireguard_peer_new (void

nm_wireguard_peer_new_clone ()

NMWireGuardPeer *
 nm_wireguard_peer_new_clone (const NMWireGuardPeer *self,
-                             gboolean with_secrets);
+ gboolean with_secrets);

Parameters

@@ -479,7 +479,7 @@ nm_wireguard_peer_new_clone (const - @@ -579,7 +579,7 @@ an unsealed copy with

nm_wireguard_peer_is_sealed ()

-
gboolean
+
gboolean
 nm_wireguard_peer_is_sealed (const NMWireGuardPeer *self);

Parameters

@@ -625,7 +625,7 @@ nm_wireguard_peer_get_public_key (const

Returns

-

the public key or NULL if unset.

+

the public key or NULL if unset.

[transfer none]

Since: 1.16

@@ -633,10 +633,10 @@ nm_wireguard_peer_get_public_key (const

nm_wireguard_peer_set_public_key ()

-
gboolean
+
gboolean
 nm_wireguard_peer_set_public_key (NMWireGuardPeer *self,
                                   const char *public_key,
-                                  gboolean accept_invalid);
+ gboolean accept_invalid);

Reset the public key. Note that if the public key is valid, it will be normalized (which may or may not modify the set value).

It is a bug trying to modify a sealed NMWireGuardPeer instance.

@@ -657,13 +657,13 @@ will be normalized (which may or may not modify the set value).

+key or NULL to clear the public key.

- @@ -672,8 +672,8 @@ invalid, then do not modify the instance.

Returns

-

TRUE if the key was valid or NULL. Returns -FALSE for invalid keys. Depending on accept_invalid +

TRUE if the key was valid or NULL. Returns +FALSE for invalid keys. Depending on accept_invalid will an invalid key be set or not.

Since: 1.16

@@ -700,7 +700,7 @@ nm_wireguard_peer_get_preshared_key (const

Returns

-

the preshared key or NULL if unset.

+

the preshared key or NULL if unset.

[transfer none]

Since: 1.16

@@ -708,10 +708,10 @@ nm_wireguard_peer_get_preshared_key (const

nm_wireguard_peer_set_preshared_key ()

-
gboolean
+
gboolean
 nm_wireguard_peer_set_preshared_key (NMWireGuardPeer *self,
                                      const char *preshared_key,
-                                     gboolean accept_invalid);
+ gboolean accept_invalid);

Reset the preshared key. Note that if the preshared key is valid, it will be normalized (which may or may not modify the set value).

Note that the preshared-key is a secret and consequently has corresponding @@ -737,15 +737,15 @@ be accepted.

+key or NULL to clear the preshared key.

+and if FALSE is returned.

@@ -753,8 +753,8 @@ and if

Returns

-

TRUE if the preshared-key is valid, otherwise FALSE. -NULL is considered a valid value. +

TRUE if the preshared-key is valid, otherwise FALSE. +NULL is considered a valid value. If the key is invalid, it depends on accept_invalid whether the previous value was reset.

@@ -823,7 +823,7 @@ nm_wireguard_peer_set_preshared_key_flags

nm_wireguard_peer_get_persistent_keepalive ()

-
guint16
+
guint16
 nm_wireguard_peer_get_persistent_keepalive
                                (const NMWireGuardPeer *self);
@@ -854,7 +854,7 @@ keep-alive.

void
 nm_wireguard_peer_set_persistent_keepalive
                                (NMWireGuardPeer *self,
-                                guint16 persistent_keepalive);
+ guint16 persistent_keepalive);

It is a bug trying to modify a sealed NMWireGuardPeer instance.

Parameters

@@ -902,7 +902,7 @@ nm_wireguard_peer_get_endpoint (const

Returns

-

the endpoint or NULL if none was set.

+

the endpoint or NULL if none was set.

[transfer none]

Since: 1.16

@@ -910,10 +910,10 @@ nm_wireguard_peer_get_endpoint (const

nm_wireguard_peer_set_endpoint ()

-
gboolean
+
gboolean
 nm_wireguard_peer_set_endpoint (NMWireGuardPeer *self,
                                 const char *endpoint,
-                                gboolean allow_invalid);
+ gboolean allow_invalid);

Sets or clears the endpoint of self .

It is a bug trying to modify a sealed NMWireGuardPeer instance.

@@ -933,13 +933,13 @@ nm_wireguard_peer_set_endpoint (
- + - @@ -948,9 +948,9 @@ arguments.

Returns

-

TRUE if the endpoint is NULL or valid. For an +

TRUE if the endpoint is NULL or valid. For an invalid endpoint -argument, FALSE is returned. Depending +argument, FALSE is returned. Depending on allow_invalid , the instance will be modified.

@@ -959,7 +959,7 @@ on allow_invalid

nm_wireguard_peer_get_allowed_ips_len ()

-
guint
+
guint
 nm_wireguard_peer_get_allowed_ips_len (const NMWireGuardPeer *self);

Parameters

@@ -987,8 +987,8 @@ nm_wireguard_peer_get_allowed_ips_len (const

nm_wireguard_peer_get_allowed_ip ()

const char *
 nm_wireguard_peer_get_allowed_ip (const NMWireGuardPeer *self,
-                                  guint idx,
-                                  gboolean *out_is_valid);
+ guint idx, + gboolean *out_is_valid);

Parameters

with_secrets

if TRUE, the preshared-key secrets are copied +

if TRUE, the preshared-key secrets are copied as well. Otherwise, they will be removed.

 

public_key

the new public -key or NULL to clear the public key.

[nullable][transfer none]

accept_invalid

if TRUE and public_key -is not NULL and +

if TRUE and public_key +is not NULL and invalid, then do not modify the instance.

 

preshared_key

the new preshared -key or NULL to clear the preshared key.

[nullable][transfer none]

accept_invalid

whether to allow setting the key to an invalid -value. If FALSE, self +value. If FALSE, self is unchanged if the key is invalid -and if FALSE is returned.

 

endpoint

the socket address endpoint to set or NULL.

the socket address endpoint to set or NULL.

 

allow_invalid

if TRUE, also invalid values are set. -If FALSE, the function does nothing for invalid endpoint +

if TRUE, also invalid values are set. +If FALSE, the function does nothing for invalid endpoint arguments.

 
@@ -1011,7 +1011,7 @@ retrieve.

-

the allowed-ip setting at index idx . If idx -is out of range, NULL will be returned.

+is out of range, NULL will be returned.

[transfer none][nullable]

Since: 1.16

@@ -1058,10 +1058,10 @@ nm_wireguard_peer_clear_allowed_ips (

nm_wireguard_peer_append_allowed_ip ()

-
gboolean
+
gboolean
 nm_wireguard_peer_append_allowed_ip (NMWireGuardPeer *self,
                                      const char *allowed_ip,
-                                     gboolean accept_invalid);
+ gboolean accept_invalid);

Appends allowed_ip setting to the list. This does not check for duplicates and always appends allowed_ip @@ -1093,10 +1093,10 @@ appended, but later verification will fail.

- +in face of invalid values and returns FALSE.

@@ -1104,7 +1104,7 @@ in face of invalid values and returns

Returns

-

TRUE if the value is a valid allowed-ips value, FALSE otherwise. +

TRUE if the value is a valid allowed-ips value, FALSE otherwise. Depending on accept_invalid , also invalid values are added.

@@ -1113,9 +1113,9 @@ Depending on accept_invalid

nm_wireguard_peer_remove_allowed_ip ()

-
gboolean
+
gboolean
 nm_wireguard_peer_remove_allowed_ip (NMWireGuardPeer *self,
-                                     guint idx);
+ guint idx);

Removes the allowed-ip at the given idx . This shifts all following entries one index down.

@@ -1137,7 +1137,7 @@ following entries one index down.

@@ -1146,20 +1146,20 @@ and nothing is done.

Returns

-

TRUE if idx +

TRUE if idx was valid and the allowed-ip was removed. -FALSE otherwise, and the peer will not be changed.

+FALSE otherwise, and the peer will not be changed.

Since: 1.16


nm_wireguard_peer_is_valid ()

-
gboolean
+
gboolean
 nm_wireguard_peer_is_valid (const NMWireGuardPeer *self,
-                            gboolean check_non_secrets,
-                            gboolean check_secrets,
-                            GError **error);
+ gboolean check_non_secrets, + gboolean check_secrets, + GError **error);

Parameters

out_is_valid

TRUE if the returned value is a valid allowed-ip +

TRUE if the returned value is a valid allowed-ip setting. This parameter is wrongly not marked as (out) argument, it is thus not accessible via introspection. This cannot be fixed without @@ -1026,7 +1026,7 @@ breaking API for introspection users.

accept_invalid

if TRUE, also invalid allowed_ip +

if TRUE, also invalid allowed_ip value will be appended. Otherwise, the function does nothing -in face of invalid values and returns FALSE.

 

idx

the index from zero to (allowed-ips-len - 1) to -retrieve. If the index is out of range, FALSE is returned +retrieve. If the index is out of range, FALSE is returned and nothing is done.

 
@@ -1176,19 +1176,19 @@ nm_wireguard_peer_is_valid (const - - - + @@ -1196,7 +1196,7 @@ Otherwise, they are ignored for this purpose.

Returns

-

TRUE if the peer is valid or fails with an error +

TRUE if the peer is valid or fails with an error reason.

Since: 1.16

@@ -1279,7 +1279,7 @@ nm_setting_wireguard_get_private_key (

Returns

-

the set private-key or NULL.

+

the set private-key or NULL.

[transfer none]

Since: 1.16

@@ -1314,7 +1314,7 @@ nm_setting_wireguard_get_private_key_flags

nm_setting_wireguard_get_listen_port ()

-
guint16
+
guint16
 nm_setting_wireguard_get_listen_port (NMSettingWireGuard *self);

Parameters

@@ -1340,7 +1340,7 @@ nm_setting_wireguard_get_listen_port (

nm_setting_wireguard_get_fwmark ()

-
guint32
+
guint32
 nm_setting_wireguard_get_fwmark (NMSettingWireGuard *self);

Parameters

@@ -1366,7 +1366,7 @@ nm_setting_wireguard_get_fwmark (

nm_setting_wireguard_get_peers_len ()

-
guint
+
guint
 nm_setting_wireguard_get_peers_len (NMSettingWireGuard *self);

Parameters

@@ -1394,7 +1394,7 @@ nm_setting_wireguard_get_peers_len (

nm_setting_wireguard_get_peer ()

NMWireGuardPeer *
 nm_setting_wireguard_get_peer (NMSettingWireGuard *self,
-                               guint idx);
+ guint idx);

Parameters

check_secrets

if TRUE, non-secret properties are validated. +

if TRUE, non-secret properties are validated. Otherwise, they are ignored for this purpose.

 

check_non_secrets

if TRUE, secret properties are validated. +

if TRUE, secret properties are validated. Otherwise, they are ignored for this purpose.

 

error

the GError location for returning the failure reason.

the GError location for returning the failure reason.

 
@@ -1421,7 +1421,7 @@ nm_setting_wireguard_get_peer (

Returns

the NMWireGuardPeer entry at index idx -. If the index is out of range, NULL is returned.

+. If the index is out of range, NULL is returned.

[transfer none]

Since: 1.16

@@ -1433,7 +1433,7 @@ index idx nm_setting_wireguard_get_peer_by_public_key (NMSettingWireGuard *self, const char *public_key, - guint *out_idx); + guint *out_idx);

Parameters

@@ -1467,7 +1467,7 @@ this is set to the

Returns

the NMWireGuardPeer instance with a -matching public key. If no such peer exists, NULL is returned.

+matching public key. If no such peer exists, NULL is returned.

[transfer none][nullable]

Since: 1.16

@@ -1478,7 +1478,7 @@ matching public key. If no such peer exists, void nm_setting_wireguard_set_peer (NMSettingWireGuard *self, NMWireGuardPeer *peer, - guint idx); + guint idx);

If idx is one past the last peer, the behavior is the same as nm_setting_wireguard_append_peer(). @@ -1572,9 +1572,9 @@ instance.


nm_setting_wireguard_remove_peer ()

-
gboolean
+
gboolean
 nm_setting_wireguard_remove_peer (NMSettingWireGuard *self,
-                                  guint idx);
+ guint idx);

Parameters

@@ -1599,7 +1599,7 @@ nm_setting_wireguard_remove_peer (

Returns

-

TRUE if idx +

TRUE if idx was in range and a peer was removed. Otherwise, self is unchanged.

@@ -1609,7 +1609,7 @@ is unchanged.


nm_setting_wireguard_clear_peers ()

-
guint
+
guint
 nm_setting_wireguard_clear_peers (NMSettingWireGuard *self);

Parameters

@@ -1635,7 +1635,7 @@ nm_setting_wireguard_clear_peers (

nm_setting_wireguard_get_peer_routes ()

-
gboolean
+
gboolean
 nm_setting_wireguard_get_peer_routes (NMSettingWireGuard *self);

Parameters

@@ -1661,7 +1661,7 @@ nm_setting_wireguard_get_peer_routes (

nm_setting_wireguard_get_mtu ()

-
guint32
+
guint32
 nm_setting_wireguard_get_mtu (NMSettingWireGuard *self);

Parameters

@@ -1851,6 +1851,6 @@ nm_setting_wireguard_get_ip6_auto_default_route
+
Generated by GTK-Doc V1.34.0
\ No newline at end of file -- cgit 1.3.0-6-gf8a5