libnm-util Reference Manual: NMSettingOlpcMesh

@@ -31,274 +37,193 @@

NMSettingOlpcMesh

- +

Synopsis

#define             NM_SETTING_OLPC_MESH_SETTING_NAME
+enum                NMSettingOlpcMeshError;
+#define             NM_SETTING_OLPC_MESH_ERROR
+GQuark              nm_setting_olpc_mesh_error_quark    (void);
+#define             NM_SETTING_OLPC_MESH_SSID
+#define             NM_SETTING_OLPC_MESH_CHANNEL
+#define             NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS
+                    NMSettingOlpcMesh;
+                    NMSettingOlpcMeshClass;
+NMSetting *         nm_setting_olpc_mesh_new            (void);
+const GByteArray *  nm_setting_olpc_mesh_get_ssid       (NMSettingOlpcMesh *setting);
+guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
+const GByteArray *  nm_setting_olpc_mesh_get_dhcp_anycast_address
+                                                        (NMSettingOlpcMesh *setting);
+

Functions

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

-GQuark -	-nm_setting_olpc_mesh_error_quark () -
-NMSetting * -	-nm_setting_olpc_mesh_new () -
const GByteArray * -	-nm_setting_olpc_mesh_get_ssid () -
-guint32 -	-nm_setting_olpc_mesh_get_channel () -
const GByteArray * -	-nm_setting_olpc_mesh_get_dhcp_anycast_address () -

Object Hierarchy

+  GEnum
+   +----NMSettingOlpcMeshError
+

+  GObject
+   +----NMSetting
+         +----NMSettingOlpcMesh
+

Properties

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

guint	channel	Read / Write / Construct
-GArray_guchar_ *	dhcp-anycast-address	Read / Write
-GArray_guchar_ *	ssid	Read / Write

+  "channel"                  guint                 : Read / Write / Construct
+  "dhcp-anycast-address"     GArray_guchar_*       : Read / Write
+  "ssid"                     GArray_guchar_*       : Read / Write
+

Types and Values

Description

+ +

Details

NM_SETTING_OLPC_MESH_SETTING_NAME

#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
+

enum NMSettingOlpcMeshError

typedef enum {
+	NM_SETTING_OLPC_MESH_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
+	NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
+	NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
+} NMSettingOlpcMeshError;
+

--++ - - - - - - - - - - - - - - + + - - + + - - + +

#define	NM_SETTING_OLPC_MESH_SETTING_NAME
enum	NMSettingOlpcMeshError
#define	NM_SETTING_OLPC_MESH_ERROR
#define	NM_SETTING_OLPC_MESH_SSID	`NM_SETTING_OLPC_MESH_ERROR_UNKNOWN`	unknown or unclassified error +
#define	NM_SETTING_OLPC_MESH_CHANNEL	`NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY`	the property was invalid +
#define	NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS	`NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY`	the property was missing and is +required +

Object Hierarchy

    GEnum
-    ╰── NMSettingOlpcMeshError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingOlpcMesh
+
+
+NM_SETTING_OLPC_MESH_ERROR
+#define NM_SETTING_OLPC_MESH_ERROR nm_setting_olpc_mesh_error_quark ()
 
-
-
-Description
 
 
 
-
-Functions
+
 
-nm_setting_olpc_mesh_error_quark ()
-GQuark
-nm_setting_olpc_mesh_error_quark (void);
+nm_setting_olpc_mesh_error_quark ()
+GQuark              nm_setting_olpc_mesh_error_quark    (void);
 
 
-
-Returns
-
-
 
 
 
-nm_setting_olpc_mesh_new ()
-NMSetting *
-nm_setting_olpc_mesh_new (void);
-Creates a new NMSettingOlpcMesh object with default values.
-
-Returns
- the new empty NMSettingOlpcMesh object
-
-
+NM_SETTING_OLPC_MESH_SSID
+#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
+
+
+
 
 
 
-nm_setting_olpc_mesh_get_ssid ()
-const GByteArray *
-nm_setting_olpc_mesh_get_ssid (NMSettingOlpcMesh *setting);
+NM_SETTING_OLPC_MESH_CHANNEL
+#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
+
 
 
-
-Returns
-
-
 
 
 
-nm_setting_olpc_mesh_get_channel ()
-guint32
-nm_setting_olpc_mesh_get_channel (NMSettingOlpcMesh *setting);
+NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS
+#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
+
 
 
-
-Returns
-
-
 
 
 
-nm_setting_olpc_mesh_get_dhcp_anycast_address ()
-const GByteArray *
-nm_setting_olpc_mesh_get_dhcp_anycast_address
-                               (NMSettingOlpcMesh *setting);
+NMSettingOlpcMesh
+typedef struct _NMSettingOlpcMesh NMSettingOlpcMesh;
 
 
-
-Returns
-
-
 
-
-
-Types and Values
+
 
-NM_SETTING_OLPC_MESH_SETTING_NAME
-#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
+NMSettingOlpcMeshClass
+typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingOlpcMeshClass;
 
 
 
 
 
 
-enum NMSettingOlpcMeshError
-
-Members
-
+nm_setting_olpc_mesh_new ()
+NMSetting *         nm_setting_olpc_mesh_new            (void);
+
+Creates a new NMSettingOlpcMesh object with default values.
+
+
---++
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
 





 NM_SETTING_OLPC_MESH_ERROR_UNKNOWN 
-unknown or unclassified error
-  
NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY 
-the property was invalid
-  
NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY 
-the property was missing and is
-required
-  
Returns : the new empty NMSettingOlpcMesh object
 
 
-
-
-
-NM_SETTING_OLPC_MESH_ERROR
-#define NM_SETTING_OLPC_MESH_ERROR nm_setting_olpc_mesh_error_quark ()
-
-
-
-
 
 
-NM_SETTING_OLPC_MESH_SSID
-#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
-
+nm_setting_olpc_mesh_get_ssid ()
+const GByteArray *  nm_setting_olpc_mesh_get_ssid       (NMSettingOlpcMesh *setting);
 
 
 
 
 
-NM_SETTING_OLPC_MESH_CHANNEL
-#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
-
+nm_setting_olpc_mesh_get_channel ()
+guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
 
 
 
 
 
-NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS
-#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
-
+nm_setting_olpc_mesh_get_dhcp_anycast_address ()
+const GByteArray *  nm_setting_olpc_mesh_get_dhcp_anycast_address
+                                                        (NMSettingOlpcMesh *setting);
 
 
 
@@ -306,30 +231,35 @@ required
 
 Property Details
 
-The “channel” property
-  “channel”                  guint
-Channel on which the mesh network to join is located.
-Flags: Read / Write / Construct
+The "channel" property
+  "channel"                  guint                 : Read / Write / Construct
+
+Channel on which the mesh network to join is located.
+
 Default value: 0
 
 
 
-The “dhcp-anycast-address” property
-  “dhcp-anycast-address”     GArray_guchar_ *
-Anycast DHCP MAC address used when requesting an IP address via DHCP.  The specific anycast address used determines which DHCP server class answers the the request.
-Flags: Read / Write
+The "dhcp-anycast-address" property
+  "dhcp-anycast-address"     GArray_guchar_*       : Read / Write
+
+Anycast DHCP MAC address used when requesting an IP address via DHCP.
+The specific anycast address used determines which DHCP server class
+answers the request.
+
 
 
 
-The “ssid” property
-  “ssid”                     GArray_guchar_ *
-SSID of the mesh network to join.
-Flags: Read / Write
+The "ssid" property
+  "ssid"                     GArray_guchar_*       : Read / Write
+
+SSID of the mesh network to join.
+
 
 
 
 
 
-          Generated by GTK-Doc V1.20
+          Generated by GTK-Doc V1.19

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

			libnm-util Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Properties +

NM_SETTING_OLPC_MESH_ERROR_UNKNOWN	- unknown or unclassified error -
NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY	- the property was invalid -
NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY	- the property was missing and is -required -
Returns :	the new empty NMSettingOlpcMesh object