From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-glib/html/NMDeviceOlpcMesh.html | 510 +++++++++++++---------------- 1 file changed, 230 insertions(+), 280 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceOlpcMesh.html') diff --git a/docs/libnm-glib/html/NMDeviceOlpcMesh.html b/docs/libnm-glib/html/NMDeviceOlpcMesh.html index 8fc759f1..482b949b 100644 --- a/docs/libnm-glib/html/NMDeviceOlpcMesh.html +++ b/docs/libnm-glib/html/NMDeviceOlpcMesh.html @@ -2,28 +2,36 @@ -libnm-glib Reference Manual: NMDeviceOlpcMesh +NMDeviceOlpcMesh - + - - - - - - - + + + + + + + + + +
@@ -31,124 +39,47 @@

NMDeviceOlpcMesh

NMDeviceOlpcMesh

- +
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - -
-GQuark - -nm_device_olpc_mesh_error_quark () -
-GObject * - -nm_device_olpc_mesh_new () -
const char * - -nm_device_olpc_mesh_get_hw_address () -
-NMDeviceWifi * - -nm_device_olpc_mesh_get_companion () -
-guint32 - -nm_device_olpc_mesh_get_active_channel () -
+
+

Synopsis

+
enum                NMDeviceOlpcMeshError;
+#define             NM_DEVICE_OLPC_MESH_ERROR
+GQuark              nm_device_olpc_mesh_error_quark     (void);
+#define             NM_DEVICE_OLPC_MESH_HW_ADDRESS
+#define             NM_DEVICE_OLPC_MESH_COMPANION
+#define             NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL
+                    NMDeviceOlpcMesh;
+                    NMDeviceOlpcMeshClass;
+GObject *           nm_device_olpc_mesh_new             (DBusGConnection *connection,
+                                                         const char *path);
+const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);
+NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);
+guint32             nm_device_olpc_mesh_get_active_channel
+                                                        (NMDeviceOlpcMesh *device);
+
-

Properties

-
----- - - - - - - - - - - - - - - - - - -
guintactive-channelRead
-NMDeviceWifi *companionRead
-gchar *hw-addressRead
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceOlpcMesh
+
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - -
enumNMDeviceOlpcMeshError
#defineNM_DEVICE_OLPC_MESH_ERROR
#defineNM_DEVICE_OLPC_MESH_HW_ADDRESS
#defineNM_DEVICE_OLPC_MESH_COMPANION
#defineNM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL
+

Implemented Interfaces

+

+NMDeviceOlpcMesh implements + GInitable and GAsyncInitable.

-

Object Hierarchy

-
    GObject
-    ╰── NMObject
-        ╰── NMDevice
-            ╰── NMDeviceOlpcMesh
+
Properties

+
+  "active-channel"           guint                 : Read
+  "companion"                NMDeviceWifi*         : Read
+  "hw-address"               gchar*                : Read
@@ -157,236 +88,255 @@

-

Functions

+

Details

-

nm_device_olpc_mesh_error_quark ()

-
GQuark
-nm_device_olpc_mesh_error_quark (void);
-

Registers an error quark for NMDeviceOlpcMesh if necessary.

-
-

Returns

-

the error quark used for NMDeviceOlpcMesh errors.

-

-
-
-
-
-

nm_device_olpc_mesh_new ()

-
GObject *
-nm_device_olpc_mesh_new (DBusGConnection *connection,
-                         const char *path);
-

Creates a new NMDeviceOlpcMesh.

-
-

Parameters

-
+

enum NMDeviceOlpcMeshError

+
typedef enum {
+	NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN = 0,                  /*< nick=UnknownError >*/
+	NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION,     /*< nick=NotOlpcMeshConnection >*/
+	NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION, /*< nick=InvalidOlpcMeshConnection >*/
+} NMDeviceOlpcMeshError;
+
+
---++ - - - + + + + + + - - - + +

connection

the DBusGConnection

 

NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN

unknown or unclassified error +

NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION

the connection was not of Olpc Mesh type +

path

the DBus object path of the device

 

NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION

the Olpc Mesh connection was invalid +
-
-

Returns

-

a new OlpcMesh device.

-

[transfer full]

-
-
-

nm_device_olpc_mesh_get_hw_address ()

-
const char *
-nm_device_olpc_mesh_get_hw_address (NMDeviceOlpcMesh *device);
-

Gets the hardware (MAC) address of the NMDeviceOlpcMesh

-
-

Parameters

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

device

a NMDeviceOlpcMesh

 
-
-
-

Returns

-

the hardware address. This is the internal string used by the -device, and must not be modified.

-

-
+

NM_DEVICE_OLPC_MESH_ERROR

+
#define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
+
+

+

-

nm_device_olpc_mesh_get_companion ()

-
NMDeviceWifi *
-nm_device_olpc_mesh_get_companion (NMDeviceOlpcMesh *device);
-

Gets the companion device of the NMDeviceOlpcMesh.

-
-

Parameters

-
+

nm_device_olpc_mesh_error_quark ()

+
GQuark              nm_device_olpc_mesh_error_quark     (void);
+

+Registers an error quark for NMDeviceOlpcMesh if necessary. +

+
---++ - - - + +

device

a NMDeviceOlpcMesh

 

Returns :

the error quark used for NMDeviceOlpcMesh errors.
-
-

Returns

-

the companion of the device of NULL.

-

[transfer none]

-
+
+
+

NM_DEVICE_OLPC_MESH_HW_ADDRESS

+
#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
+
+

+

-

nm_device_olpc_mesh_get_active_channel ()

-
guint32
-nm_device_olpc_mesh_get_active_channel
-                               (NMDeviceOlpcMesh *device);
-

Returns the active channel of the NMDeviceOlpcMesh device.

-
-

Parameters

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

device

a NMDeviceOlpcMesh

 
+

NM_DEVICE_OLPC_MESH_COMPANION

+
#define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
+
+

+

-
-

Returns

-

active channel of the device

-

+
+
+

NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

+
#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
+
+

+

+
+
+

NMDeviceOlpcMesh

+
typedef struct _NMDeviceOlpcMesh NMDeviceOlpcMesh;
+

+

+
+
+

NMDeviceOlpcMeshClass

+
typedef struct {
+	NMDeviceClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMDeviceOlpcMeshClass;
+
+

+

-
-

Types and Values

+
-

enum NMDeviceOlpcMeshError

-
-

Members

-
+

nm_device_olpc_mesh_new ()

+
GObject *           nm_device_olpc_mesh_new             (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMDeviceOlpcMesh. +

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

NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN

 -

unknown or unclassified error

+

connection :

the DBusGConnection  

NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION

 -

the connection was not of Olpc Mesh type

-		 

path :

the DBus object path of the device

NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION

 -

the Olpc Mesh connection was invalid

+

Returns :

a new OlpcMesh device. [transfer full]  
-
-

NM_DEVICE_OLPC_MESH_ERROR

-
#define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
-
-

-

-
-
-
-

NM_DEVICE_OLPC_MESH_HW_ADDRESS

-
#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
-
+

nm_device_olpc_mesh_get_hw_address ()

+
const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);

+Gets the hardware (MAC) address of the NMDeviceOlpcMesh

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

device :

a NMDeviceOlpcMesh +

Returns :

the hardware address. This is the internal string used by the +device, and must not be modified.
-

NM_DEVICE_OLPC_MESH_COMPANION

-
#define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
-
+

nm_device_olpc_mesh_get_companion ()

+
NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);

+Gets the companion device of the NMDeviceOlpcMesh.

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

device :

a NMDeviceOlpcMesh +

Returns :

the companion of the device of NULL. [transfer none] +
-

NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

-
#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
-
+

nm_device_olpc_mesh_get_active_channel ()

+
guint32             nm_device_olpc_mesh_get_active_channel
+                                                        (NMDeviceOlpcMesh *device);

+Returns the active channel of the NMDeviceOlpcMesh device.

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

device :

a NMDeviceOlpcMesh +

Returns :

active channel of the device

Property Details

-

The “active-channel” property

-
  “active-channel”           guint
-

Active channel.

-

Flags: Read

+

The "active-channel" property

+
  "active-channel"           guint                 : Read
+

+The device's active channel. +

Default value: 0

-

The “companion” property

-
  “companion”                NMDeviceWifi *
-

Companion device.

-

Flags: Read

+

The "companion" property

+
  "companion"                NMDeviceWifi*         : Read
+

+The companion device. +

-

The “hw-address” property

-
  “hw-address”               gchar *
-

Hardware MAC address.

-

Flags: Read

+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

Default value: NULL

- Generated by GTK-Doc V1.20
+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5