nm-utils

@@ -35,29 +35,11 @@

Synopsis

 #include <nm-utils.h>
 
-#define             nm_print_backtrace
-#define             nm_get_timestamp                    (timestamp)
-#define             nm_info                             (fmt,
-                                                         args...)
-#define             nm_info_str                         (fmt_str,
-                                                         args...)
-#define             nm_debug                            (fmt,
-                                                         args...)
-#define             nm_debug_str                        (fmt_str,
-                                                         args...)
-#define             nm_warning                          (fmt,
-                                                         args...)
-#define             nm_warning_str                      (fmt_str,
-                                                         args...)
-#define             nm_error                            (fmt,
-                                                         args...)
-#define             nm_error_str                        (fmt_str,
-                                                         args...)
 gboolean            nm_utils_init                       (GError **error);
 void                nm_utils_deinit                     (void);
 gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
@@ -67,8 +49,7 @@ const char *        gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
                                                          const GByteArray *ssid2,
                                                          gboolean ignore_trailing_null);
-char *              nm_utils_ssid_to_utf8               (const char *ssid,
-                                                         guint32 len);
+char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
 GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);
 void                nm_utils_slist_free                 (GSList *list,
                                                          GDestroyNotify elem_destroy_fn);
@@ -114,216 +95,16 @@ enum                const char *band);

Description

A collection of utility functions for working SSIDs, IP addresses, WiFi access points and devices, among other things.

Details

nm_print_backtrace

#define             nm_print_backtrace()

-Prints a backtrace of the calling process to the logging location. -

nm_get_timestamp()

#define             nm_get_timestamp(timestamp)

-For debugging only. -

-- - - - -

timestamp :

location in which to place the current timestamp -

nm_info()

#define             nm_info(fmt, args...)

-- - - - - - - - - - -

`fmt` :	-
`args...` :	-

nm_info_str()

#define             nm_info_str(fmt_str, args...)

-- - - - - - - - - - -

`fmt_str` :	-
`args...` :	-

nm_debug()

#define             nm_debug(fmt, args...)

-- - - - - - - - - - -

`fmt` :	-
`args...` :	-

nm_debug_str()

#define             nm_debug_str(fmt_str, args...)

-- - - - - - - - - - -

`fmt_str` :	-
`args...` :	-

nm_warning()

#define             nm_warning(fmt, args...)

-- - - - - - - - - - -

`fmt` :	-
`args...` :	-

nm_warning_str()

#define             nm_warning_str(fmt_str, args...)

-- - - - - - - - - - -

`fmt_str` :	-
`args...` :	-

nm_error()

#define             nm_error(fmt, args...)

-- - - - - - - - - - -

`fmt` :	-
`args...` :	-

nm_error_str()

#define             nm_error_str(fmt_str, args...)

-- - - - - - - - - - -

`fmt_str` :	-
`args...` :	-

nm_utils_init ()

gboolean            nm_utils_init                       (GError **error);

@@ -342,14 +123,13 @@ libnm-util can also be done. This function can be called more than once.

Returns :

- TRUE if the initialization was successful, FALSE on failure. - +TRUE if the initialization was successful, FALSE on failure.

nm_utils_deinit ()

void                nm_utils_deinit                     (void);

@@ -360,7 +140,7 @@ called again.

nm_utils_is_empty_ssid ()

gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
                                                          int len);

@@ -374,8 +154,7 @@ number of known SSID-cloaking methods.

ssid :

-pointer to a buffer containing the SSID data - +pointer to a buffer containing the SSID data

len :

@@ -384,14 +163,13 @@ number of known SSID-cloaking methods.

Returns :

- TRUE if the SSID is "empty", FALSE if it is not - +TRUE if the SSID is "empty", FALSE if it is not

nm_utils_escape_ssid ()

const char *        nm_utils_escape_ssid                (const guint8 *ssid,
                                                          guint32 len);

@@ -406,8 +184,7 @@ be used for display of SSIDs.

ssid :

-pointer to a buffer containing the SSID data - +pointer to a buffer containing the SSID data

len :

@@ -416,15 +193,14 @@ be used for display of SSIDs.

Returns :

- pointer to the escaped SSID, which uses an internal static buffer -and will be overwritten by subsequent calls to this function - +pointer to the escaped SSID, which uses an internal static buffer +and will be overwritten by subsequent calls to this function

nm_utils_same_ssid ()

gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
                                                          const GByteArray *ssid2,
@@ -442,32 +218,27 @@ NULLs, even though that is functionally pointless.
 
 
 ssid1 :
-first SSID data to compare
-
+first SSID data to compare
 
 
 ssid2 :
-second SSID data to compare
-
+second SSID data to compare
 
 
 ignore_trailing_null :
-TRUE to ignore one trailing NULL byte
-
+TRUE to ignore one trailing NULL byte
 
 
 Returns :
- TRUE if the SSIDs are the same, FALSE if they are not
-
+TRUE if the SSIDs are the same, FALSE if they are not

nm_utils_ssid_to_utf8 ()

char *              nm_utils_ssid_to_utf8               (const char *ssid,
-                                                         guint32 len);

char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);

WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may contain embedded NULLs and other unprintable characters. Often it is @@ -500,26 +271,20 @@ _only_.

ssid :

-pointer to a buffer containing the SSID data - - - -

len :

-length of the SSID data in ssid - +a byte array containing the SSID data

Returns :

- an allocated string containing a UTF-8 representation of the -SSID, which must be freed by the caller using g_free(). Returns NULL -on errors. +an allocated string containing a UTF-8 +representation of the SSID, which must be freed by the caller using g_free(). +Returns NULL on errors. [transfer full]

nm_utils_gvalue_hash_dup ()

GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);

@@ -530,20 +295,19 @@ Utility function to duplicate a hash table of GValues.

hash :

-a GHashTable mapping string:GValue - +a GHashTable mapping string:GValue

Returns :

- a newly allocated duplicated GHashTable, caller must free the -returned hash with g_hash_table_unref() or g_hash_table_destroy() +a newly allocated duplicated GHashTable, caller must free the +returned hash with g_hash_table_unref() or g_hash_table_destroy(). [transfer container][element-type utf8 GObject.Value]

nm_utils_slist_free ()

void                nm_utils_slist_free                 (GSList *list,
                                                          GDestroyNotify elem_destroy_fn);

@@ -567,7 +331,7 @@ Utility function to free a +

enum NMUtilsSecurityType

typedef enum {
 	NMU_SEC_INVALID = 0,
@@ -585,7 +349,7 @@ Utility function to free a 
+
 nm_utils_security_valid ()
 gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
                                                          guint32 wifi_caps,
@@ -616,13 +380,11 @@ e.g. NMU_SEC_STATIC_WEP
 
 
 have_ap :
-whether the ap_flags, ap_wpa, and ap_rsn arguments are valid
-
+whether the ap_flags, ap_wpa, and ap_rsn arguments are valid
 
 
 adhoc :
-whether the capabilities being tested are from an Ad-Hoc AP (IBSS)
-
+whether the capabilities being tested are from an Ad-Hoc AP (IBSS)
 
 
 ap_flags :
@@ -632,32 +394,29 @@ e.g. NMU_SEC_STATIC_WEP
 
 ap_wpa :
 bitfield of AP capabilties derived from the AP's WPA beacon,
-e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)
-
+e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)
 
 
 ap_rsn :
 bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon,
-e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)
-
+e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)
 
 
 Returns :
- TRUE if the device capabilities and AP capabilties intersect and are
-compatible with the desired type, FALSE if they are not
-
+TRUE if the device capabilities and AP capabilties intersect and are
+compatible with the desired type, FALSE if they are not

nm_utils_ip4_addresses_from_gvalue ()

GSList *            nm_utils_ip4_addresses_from_gvalue  (const GValue *value);

Utility function to convert a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, -and prefix) into a GSList of NMIP4Address objects. The specific format of +and prefix) into a GSList of NMIP4Address objects. The specific format of this serialization is not guaranteed to be stable and the GArray may be extended in the future.

@@ -666,24 +425,23 @@ extended in the future.

value :

-gvalue containing a GPtrArray of GArrays of guint32s - +gvalue containing a GPtrArray of GArrays of guint32s

Returns :

- a newly allocated GSList of NMIP4Address objects +a newly allocated GSList of NMIP4Address objects. [transfer full][element-type NetworkManager.IP4Address]

nm_utils_ip4_addresses_to_gvalue ()

void                nm_utils_ip4_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);

-Utility function to convert a GSList of NMIP4Address objects into a +Utility function to convert a GSList of NMIP4Address objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, and prefix). The specific format of this serialization is not guaranteed to be stable and may be @@ -694,27 +452,25 @@ extended in the future.

list :

-a list of NMIP4Address objects - +a list of NMIP4Address objects

value :

a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). - +g_value_unset().

nm_utils_ip4_routes_from_gvalue ()

GSList *            nm_utils_ip4_routes_from_gvalue     (const GValue *value);

Utility function to convert a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, -prefix, and metric) into a GSList of NMIP4Route objects. The specific +prefix, and metric) into a GSList of NMIP4Route objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future.

@@ -723,24 +479,23 @@ extended in the future.

value :

-gvalue containing a GPtrArray of GArrays of guint32s - +gvalue containing a GPtrArray of GArrays of guint32s

Returns :

- a newly allocated GSList of NMIP4Route objects +a newly allocated GSList of NMIP4Route objects. [transfer full][element-type NetworkManager.IP4Route]

nm_utils_ip4_routes_to_gvalue ()

void                nm_utils_ip4_routes_to_gvalue       (GSList *list,
                                                          GValue *value);

-Utility function to convert a GSList of NMIP4Route objects into a +Utility function to convert a GSList of NMIP4Route objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, prefix, and metric). The specific format of this serialization is not guaranteed to be stable and may @@ -751,21 +506,19 @@ be extended in the future.

list :

-a list of NMIP4Route objects - +a list of NMIP4Route objects

value :

a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset(). - +g_value_unset().

nm_utils_ip4_netmask_to_prefix ()

guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);

@@ -773,19 +526,17 @@ which should be unset by the caller (when no longer needed) with - + - +

`netmask` :	an IPv4 netmask in network byte order -	an IPv4 netmask in network byte order
Returns :	the CIDR prefix represented by the netmask -	the CIDR prefix represented by the netmask

nm_utils_ip4_prefix_to_netmask ()

guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);

@@ -793,19 +544,17 @@ which should be unset by the caller (when no longer needed) with - + - +

`prefix` :	a CIDR prefix -	a CIDR prefix
Returns :	the netmask represented by the prefix -	the netmask represented by the prefix

nm_utils_ip4_get_default_prefix ()

guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);

@@ -819,25 +568,23 @@ falls in the predefined classes.

ip :

-an IPv4 address (in network byte order) - +an IPv4 address (in network byte order)

Returns :

- the default class prefix for the given IP - +the default class prefix for the given IP

nm_utils_ip6_addresses_from_gvalue ()

GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);

Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 representing a list of NetworkManager IPv6 addresses (which is a tuple of address, -prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of +prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of this serialization is not guaranteed to be stable and the GValueArray may be extended in the future.

@@ -846,24 +593,23 @@ extended in the future.

value :

-gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32 - +gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32

Returns :

- a newly allocated GSList of NMIP6Address objects +a newly allocated GSList of NMIP6Address objects. [transfer full][element-type NetworkManager.IP6Address]

nm_utils_ip6_addresses_to_gvalue ()

void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);

-Utility function to convert a GSList of NMIP6Address objects into a +Utility function to convert a GSList of NMIP6Address objects into a GPtrArray of GValueArrays representing a list of NetworkManager IPv6 addresses (which is a tuple of address, prefix, and gateway). The specific format of this serialization is not guaranteed to be stable and may be extended in the @@ -874,28 +620,26 @@ future.

list :

-a list of NMIP6Address objects - +a list of NMIP6Address objects

value :

a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). - +g_value_unset().

nm_utils_ip6_routes_from_gvalue ()

GSList *            nm_utils_ip6_routes_from_gvalue     (const GValue *value);

Utility function GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric) -into a GSList of NMIP6Route objects. The specific format of this serialization +into a GSList of NMIP6Route objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future.

@@ -904,24 +648,23 @@ is not guaranteed to be stable and may be extended in the future. +(GArray of guchars), and guint32 -

`value` :	gvalue containing a GPtrArray of GValueArrays of (GArray or guchars), guint32, -(GArray of guchars), and guint32 -
Returns :	a newly allocated GSList of NMIP6Route objects +	a newly allocated GSList of NMIP6Route objects. [transfer full][element-type NetworkManager.IP6Route]

nm_utils_ip6_routes_to_gvalue ()

void                nm_utils_ip6_routes_to_gvalue       (GSList *list,
                                                          GValue *value);

-Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of +Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric). The specific format of this serialization is not @@ -932,80 +675,48 @@ guaranteed to be stable and may be extended in the future.

list :

-a list of NMIP6Route objects - +a list of NMIP6Route objects

value :

a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset(). - +g_value_unset().

nm_utils_ip6_dns_from_gvalue ()

GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);

-- - - - - - - - - - -

`value` :	-
Returns :	-

nm_utils_ip6_dns_to_gvalue ()

void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
                                                          GValue *value);

-- - - - - - - - - - -

`list` :	-
`value` :	-

nm_utils_uuid_generate ()

char *              nm_utils_uuid_generate              (void);

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection +

a newly allocated UUID suitable for use as the NMSettingConnection object's "id": property. Should be freed with g_free()

nm_utils_uuid_generate_from_string ()

char *              nm_utils_uuid_generate_from_string  (const char *s);

@@ -1016,20 +727,18 @@ For a given s, this function will always

s :

-a string to use as the seed for the UUID - +a string to use as the seed for the UUID

Returns :

- a newly allocated UUID suitable for use as the NMSettingConnection -object's "id": property - +a newly allocated UUID suitable for use as the NMSettingConnection +object's "id": property

nm_utils_rsa_key_encrypt ()

GByteArray *        nm_utils_rsa_key_encrypt            (const GByteArray *data,
                                                          const char *in_password,
@@ -1045,36 +754,34 @@ suitable for writing to a file.
 
 
 data :
-RSA private key data to be encrypted
-
+RSA private key data to be encrypted
 
 
 in_password :
-existing password to use, if any
+existing password to use, if any. [allow-none]
 
 
 
 out_password :
 if in_password was NULL, a random password will be generated
- and returned in this argument
+and returned in this argument. [out][allow-none]
 
 
 
 error :
-detailed error information on return, if an error occurred
-
+detailed error information on return, if an error occurred
 
 
 Returns :
- on success, PEM-formatted data suitable for writing to a PEM-formatted
-certificate/private key file.
+on success, PEM-formatted data suitable for writing to a PEM-formatted
+certificate/private key file. [transfer full]

nm_utils_wifi_freq_to_channel ()

guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);

@@ -1085,19 +792,17 @@ Utility function to translate a WiFi frequency to its corresponding channel.

freq :

-frequency - +frequency

Returns :

- the channel represented by the frequency or 0 - +the channel represented by the frequency or 0

nm_utils_wifi_channel_to_freq ()

guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
                                                          const char *band);

@@ -1109,26 +814,23 @@ Utility function to translate a WiFi channel to its corresponding frequency.

channel :

-channel - +channel

band :

-frequency band for wireless ("a" or "bg") - +frequency band for wireless ("a" or "bg")

Returns :

- the frequency represented by the channel of the band, - or -1 when the freq is invalid, or 0 when the band - is invalid - +the frequency represented by the channel of the band, +or -1 when the freq is invalid, or 0 when the band +is invalid

nm_utils_wifi_find_next_channel ()

guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
                                                          int direction,
@@ -1141,29 +843,25 @@ Utility function to find out next/previous WiFi channel for a channel.
 
 
 channel :
-current channel
-
+current channel
 
 
 direction :
-whether going downward (0 or less) or upward (1 or more)
-
+whether going downward (0 or less) or upward (1 or more)
 
 
 band :
-frequency band for wireless ("a" or "bg")
-
+frequency band for wireless ("a" or "bg")
 
 
 Returns :
- the next channel in the specified direction or 0
-
+the next channel in the specified direction or 0

nm_utils_wifi_is_channel_valid ()

gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
                                                          const char *band);

@@ -1175,18 +873,15 @@ Utility function to verify WiFi channel validity.

channel :

-channel - +channel

band :

-frequency band for wireless ("a" or "bg") - +frequency band for wireless ("a" or "bg")

Returns :

- TRUE or FALSE - +TRUE or FALSE

@@ -1195,6 +890,6 @@ Utility function to verify WiFi channel validity.

+ Generated by GTK-Doc V1.17

\ No newline at end of file -- cgit 1.3.0-6-gf8a5 From 8baa1aca8dfd35e3190d7d5655eb83b5b901e263 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 21 Apr 2011 10:42:53 +0200 Subject: Imported Upstream version 0.8.4.0 --- docs/libnm-util/html/libnm-util-nm-utils.html | 535 ++++++++++++++++++++------ 1 file changed, 420 insertions(+), 115 deletions(-) (limited to 'docs/libnm-util/html/libnm-util-nm-utils.html') diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index f2650339..ccf9ab5e 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -8,7 +8,7 @@ - + @@ -26,7 +26,7 @@ Description -

@@ -35,11 +35,29 @@

Synopsis

 #include <nm-utils.h>
 
+#define             nm_print_backtrace
+#define             nm_get_timestamp                    (timestamp)
+#define             nm_info                             (fmt,
+                                                         args...)
+#define             nm_info_str                         (fmt_str,
+                                                         args...)
+#define             nm_debug                            (fmt,
+                                                         args...)
+#define             nm_debug_str                        (fmt_str,
+                                                         args...)
+#define             nm_warning                          (fmt,
+                                                         args...)
+#define             nm_warning_str                      (fmt_str,
+                                                         args...)
+#define             nm_error                            (fmt,
+                                                         args...)
+#define             nm_error_str                        (fmt_str,
+                                                         args...)
 gboolean            nm_utils_init                       (GError **error);
 void                nm_utils_deinit                     (void);
 gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
@@ -49,7 +67,8 @@ const char *        gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
                                                          const GByteArray *ssid2,
                                                          gboolean ignore_trailing_null);
-char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
+char *              nm_utils_ssid_to_utf8               (const char *ssid,
+                                                         guint32 len);
 GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);
 void                nm_utils_slist_free                 (GSList *list,
                                                          GDestroyNotify elem_destroy_fn);
@@ -95,16 +114,216 @@ enum                const char *band);

Description

A collection of utility functions for working SSIDs, IP addresses, WiFi access points and devices, among other things.

Details

nm_print_backtrace

#define             nm_print_backtrace()

+Prints a backtrace of the calling process to the logging location. +

nm_get_timestamp()

#define             nm_get_timestamp(timestamp)

+For debugging only. +

++ + + + +

timestamp :

location in which to place the current timestamp +

nm_info()

#define             nm_info(fmt, args...)

++ + + + + + + + + + +

`fmt` :	+
`args...` :	+

nm_info_str()

#define             nm_info_str(fmt_str, args...)

++ + + + + + + + + + +

`fmt_str` :	+
`args...` :	+

nm_debug()

#define             nm_debug(fmt, args...)

++ + + + + + + + + + +

`fmt` :	+
`args...` :	+

nm_debug_str()

#define             nm_debug_str(fmt_str, args...)

++ + + + + + + + + + +

`fmt_str` :	+
`args...` :	+

nm_warning()

#define             nm_warning(fmt, args...)

++ + + + + + + + + + +

`fmt` :	+
`args...` :	+

nm_warning_str()

#define             nm_warning_str(fmt_str, args...)

++ + + + + + + + + + +

`fmt_str` :	+
`args...` :	+

nm_error()

#define             nm_error(fmt, args...)

++ + + + + + + + + + +

`fmt` :	+
`args...` :	+

nm_error_str()

#define             nm_error_str(fmt_str, args...)

++ + + + + + + + + + +

`fmt_str` :	+
`args...` :	+

nm_utils_init ()

gboolean            nm_utils_init                       (GError **error);

@@ -123,13 +342,14 @@ libnm-util can also be done. This function can be called more than once.

Returns :

-TRUE if the initialization was successful, FALSE on failure. + TRUE if the initialization was successful, FALSE on failure. +

nm_utils_deinit ()

void                nm_utils_deinit                     (void);

@@ -140,7 +360,7 @@ called again.

nm_utils_is_empty_ssid ()

gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
                                                          int len);

@@ -154,7 +374,8 @@ number of known SSID-cloaking methods.

ssid :

-pointer to a buffer containing the SSID data +pointer to a buffer containing the SSID data +

len :

@@ -163,13 +384,14 @@ number of known SSID-cloaking methods.

Returns :

-TRUE if the SSID is "empty", FALSE if it is not + TRUE if the SSID is "empty", FALSE if it is not +

nm_utils_escape_ssid ()

const char *        nm_utils_escape_ssid                (const guint8 *ssid,
                                                          guint32 len);

@@ -184,7 +406,8 @@ be used for display of SSIDs.

ssid :

-pointer to a buffer containing the SSID data +pointer to a buffer containing the SSID data +

len :

@@ -193,14 +416,15 @@ be used for display of SSIDs.

Returns :

-pointer to the escaped SSID, which uses an internal static buffer -and will be overwritten by subsequent calls to this function + pointer to the escaped SSID, which uses an internal static buffer +and will be overwritten by subsequent calls to this function +

nm_utils_same_ssid ()

gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
                                                          const GByteArray *ssid2,
@@ -218,27 +442,32 @@ NULLs, even though that is functionally pointless.
 
 
 ssid1 :
-first SSID data to compare
+first SSID data to compare
+
 
 
 ssid2 :
-second SSID data to compare
+second SSID data to compare
+
 
 
 ignore_trailing_null :
-TRUE to ignore one trailing NULL byte
+TRUE to ignore one trailing NULL byte
+
 
 
 Returns :
-TRUE if the SSIDs are the same, FALSE if they are not
+ TRUE if the SSIDs are the same, FALSE if they are not
+

nm_utils_ssid_to_utf8 ()

char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);

char *              nm_utils_ssid_to_utf8               (const char *ssid,
+                                                         guint32 len);

WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may contain embedded NULLs and other unprintable characters. Often it is @@ -271,20 +500,26 @@ _only_.

ssid :

-a byte array containing the SSID data +pointer to a buffer containing the SSID data + + + +

len :

+length of the SSID data in ssid +

Returns :

-an allocated string containing a UTF-8 -representation of the SSID, which must be freed by the caller using g_free(). -Returns NULL on errors. [transfer full] + an allocated string containing a UTF-8 representation of the +SSID, which must be freed by the caller using g_free(). Returns NULL +on errors.

nm_utils_gvalue_hash_dup ()

GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);

@@ -295,19 +530,20 @@ Utility function to duplicate a hash table of GValues.

hash :

-a GHashTable mapping string:GValue +a GHashTable mapping string:GValue +

Returns :

-a newly allocated duplicated GHashTable, caller must free the -returned hash with g_hash_table_unref() or g_hash_table_destroy(). [transfer container][element-type utf8 GObject.Value] + a newly allocated duplicated GHashTable, caller must free the +returned hash with g_hash_table_unref() or g_hash_table_destroy()

nm_utils_slist_free ()

void                nm_utils_slist_free                 (GSList *list,
                                                          GDestroyNotify elem_destroy_fn);

@@ -331,7 +567,7 @@ Utility function to free a +

enum NMUtilsSecurityType

typedef enum {
 	NMU_SEC_INVALID = 0,
@@ -349,7 +585,7 @@ Utility function to free a 
+
 nm_utils_security_valid ()
 gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
                                                          guint32 wifi_caps,
@@ -380,11 +616,13 @@ e.g. NMU_SEC_STATIC_WEP
 
 
 have_ap :
-whether the ap_flags, ap_wpa, and ap_rsn arguments are valid
+whether the ap_flags, ap_wpa, and ap_rsn arguments are valid
+
 
 
 adhoc :
-whether the capabilities being tested are from an Ad-Hoc AP (IBSS)
+whether the capabilities being tested are from an Ad-Hoc AP (IBSS)
+
 
 
 ap_flags :
@@ -394,29 +632,32 @@ e.g. NMU_SEC_STATIC_WEP
 
 ap_wpa :
 bitfield of AP capabilties derived from the AP's WPA beacon,
-e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)
+e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)
+
 
 
 ap_rsn :
 bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon,
-e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)
+e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)
+
 
 
 Returns :
-TRUE if the device capabilities and AP capabilties intersect and are
-compatible with the desired type, FALSE if they are not
+ TRUE if the device capabilities and AP capabilties intersect and are
+compatible with the desired type, FALSE if they are not
+

nm_utils_ip4_addresses_from_gvalue ()

GSList *            nm_utils_ip4_addresses_from_gvalue  (const GValue *value);

@@ -425,23 +666,24 @@ extended in the future.

value :

-gvalue containing a GPtrArray of GArrays of guint32s +gvalue containing a GPtrArray of GArrays of guint32s +

Returns :

-a newly allocated GSList of NMIP4Address objects. [transfer full][element-type NetworkManager.IP4Address] + a newly allocated GSList of NMIP4Address objects

nm_utils_ip4_addresses_to_gvalue ()

void                nm_utils_ip4_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);

list :

-a list of NMIP4Address objects +a list of NMIP4Address objects +

value :

a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). +

nm_utils_ip4_routes_from_gvalue ()

GSList *            nm_utils_ip4_routes_from_gvalue     (const GValue *value);

@@ -479,23 +723,24 @@ extended in the future.

value :

-gvalue containing a GPtrArray of GArrays of guint32s +gvalue containing a GPtrArray of GArrays of guint32s +

Returns :

-a newly allocated GSList of NMIP4Route objects. [transfer full][element-type NetworkManager.IP4Route] + a newly allocated GSList of NMIP4Route objects

nm_utils_ip4_routes_to_gvalue ()

void                nm_utils_ip4_routes_to_gvalue       (GSList *list,
                                                          GValue *value);

list :

-a list of NMIP4Route objects +a list of NMIP4Route objects +

value :

a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). +

nm_utils_ip4_netmask_to_prefix ()

guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);

@@ -526,17 +773,19 @@ which should be unset by the caller (when no longer needed) with - + - +

`netmask` :	an IPv4 netmask in network byte order	an IPv4 netmask in network byte order +
Returns :	the CIDR prefix represented by the netmask	the CIDR prefix represented by the netmask +

nm_utils_ip4_prefix_to_netmask ()

guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);

@@ -544,17 +793,19 @@ which should be unset by the caller (when no longer needed) with - + - +

`prefix` :	a CIDR prefix	a CIDR prefix +
Returns :	the netmask represented by the prefix	the netmask represented by the prefix +

nm_utils_ip4_get_default_prefix ()

guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);

@@ -568,23 +819,25 @@ falls in the predefined classes.

ip :

-an IPv4 address (in network byte order) +an IPv4 address (in network byte order) +

Returns :

-the default class prefix for the given IP + the default class prefix for the given IP +

nm_utils_ip6_addresses_from_gvalue ()

GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);

@@ -593,23 +846,24 @@ extended in the future.

value :

-gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32 +gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32 +

Returns :

-a newly allocated GSList of NMIP6Address objects. [transfer full][element-type NetworkManager.IP6Address] + a newly allocated GSList of NMIP6Address objects

nm_utils_ip6_addresses_to_gvalue ()

void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);

list :

-a list of NMIP6Address objects +a list of NMIP6Address objects +

value :

a pointer to a GValue into which to place the converted addresses, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). +

nm_utils_ip6_routes_from_gvalue ()

GSList *            nm_utils_ip6_routes_from_gvalue     (const GValue *value);

@@ -648,23 +904,24 @@ is not guaranteed to be stable and may be extended in the future. +(GArray of guchars), and guint32 + -

`value` :	gvalue containing a GPtrArray of GValueArrays of (GArray or guchars), guint32, -(GArray of guchars), and guint32
Returns :	a newly allocated GSList of NMIP6Route objects. [transfer full][element-type NetworkManager.IP6Route] +	a newly allocated GSList of NMIP6Route objects

nm_utils_ip6_routes_to_gvalue ()

void                nm_utils_ip6_routes_to_gvalue       (GSList *list,
                                                          GValue *value);

-Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of +Utility function to convert a GSList of NMIP6Route objects into a GPtrArray of GValueArrays of (GArray or guchars), guint32, (GArray of guchars), and guint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric). The specific format of this serialization is not @@ -675,48 +932,80 @@ guaranteed to be stable and may be extended in the future.

list :

-a list of NMIP6Route objects +a list of NMIP6Route objects +

value :

a pointer to a GValue into which to place the converted routes, which should be unset by the caller (when no longer needed) with -g_value_unset(). +g_value_unset(). +

nm_utils_ip6_dns_from_gvalue ()

GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);

++ + + + + + + + + + +

`value` :	+
Returns :	+

nm_utils_ip6_dns_to_gvalue ()

void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
                                                          GValue *value);

++ + + + + + + + + + +

`list` :	+
`value` :	+

nm_utils_uuid_generate ()

char *              nm_utils_uuid_generate              (void);

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection +

a newly allocated UUID suitable for use as the NMSettingConnection object's "id": property. Should be freed with g_free()

nm_utils_uuid_generate_from_string ()

char *              nm_utils_uuid_generate_from_string  (const char *s);

@@ -727,18 +1016,20 @@ For a given s, this function will always

s :

-a string to use as the seed for the UUID +a string to use as the seed for the UUID +

Returns :

-a newly allocated UUID suitable for use as the NMSettingConnection -object's "id": property + a newly allocated UUID suitable for use as the NMSettingConnection +object's "id": property +

nm_utils_rsa_key_encrypt ()

GByteArray *        nm_utils_rsa_key_encrypt            (const GByteArray *data,
                                                          const char *in_password,
@@ -754,34 +1045,36 @@ suitable for writing to a file.
 
 
 data :
-RSA private key data to be encrypted
+RSA private key data to be encrypted
+
 
 
 in_password :
-existing password to use, if any. [allow-none]
+existing password to use, if any
 
 
 
 out_password :
 if in_password was NULL, a random password will be generated
-and returned in this argument. [out][allow-none]
+ and returned in this argument
 
 
 
 error :
-detailed error information on return, if an error occurred
+detailed error information on return, if an error occurred
+
 
 
 Returns :
-on success, PEM-formatted data suitable for writing to a PEM-formatted
-certificate/private key file. [transfer full]
+ on success, PEM-formatted data suitable for writing to a PEM-formatted
+certificate/private key file.

nm_utils_wifi_freq_to_channel ()

guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);

@@ -792,17 +1085,19 @@ Utility function to translate a WiFi frequency to its corresponding channel.

freq :

-frequency +frequency +

Returns :

-the channel represented by the frequency or 0 + the channel represented by the frequency or 0 +

nm_utils_wifi_channel_to_freq ()

guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
                                                          const char *band);

@@ -814,23 +1109,26 @@ Utility function to translate a WiFi channel to its corresponding frequency.

channel :

-channel +channel +

band :

-frequency band for wireless ("a" or "bg") +frequency band for wireless ("a" or "bg") +

Returns :

-the frequency represented by the channel of the band, -or -1 when the freq is invalid, or 0 when the band -is invalid + the frequency represented by the channel of the band, + or -1 when the freq is invalid, or 0 when the band + is invalid +

nm_utils_wifi_find_next_channel ()

guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
                                                          int direction,
@@ -843,25 +1141,29 @@ Utility function to find out next/previous WiFi channel for a channel.
 
 
 channel :
-current channel
+current channel
+
 
 
 direction :
-whether going downward (0 or less) or upward (1 or more)
+whether going downward (0 or less) or upward (1 or more)
+
 
 
 band :
-frequency band for wireless ("a" or "bg")
+frequency band for wireless ("a" or "bg")
+
 
 
 Returns :
-the next channel in the specified direction or 0
+ the next channel in the specified direction or 0
+

nm_utils_wifi_is_channel_valid ()

gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
                                                          const char *band);

@@ -873,15 +1175,18 @@ Utility function to verify WiFi channel validity.

channel :

-channel +channel +

band :

-frequency band for wireless ("a" or "bg") +frequency band for wireless ("a" or "bg") +

Returns :

-TRUE or FALSE + TRUE or FALSE +

@@ -890,6 +1195,6 @@ Utility function to verify WiFi channel validity.

+ Generated by GTK-Doc V1.15

\ No newline at end of file -- cgit 1.3.0-6-gf8a5