From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-glib/html/NMDeviceOlpcMesh.html | 510 ++++++++++++++++------------- 1 file changed, 280 insertions(+), 230 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 482b949b..a505af82 100644 --- a/docs/libnm-glib/html/NMDeviceOlpcMesh.html +++ b/docs/libnm-glib/html/NMDeviceOlpcMesh.html @@ -2,36 +2,28 @@ -NMDeviceOlpcMesh +libnm-glib Reference Manual: NMDeviceOlpcMesh - + - - - - - - - - - - + + + + + + +
@@ -39,47 +31,124 @@

NMDeviceOlpcMesh

NMDeviceOlpcMesh

- +
-
-

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);
-
+
+

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 () +
-

Object Hierarchy

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

Properties

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

Implemented Interfaces

-

-NMDeviceOlpcMesh implements - GInitable and GAsyncInitable.

+

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
-

Properties

-
-  "active-channel"           guint                 : Read
-  "companion"                NMDeviceWifi*         : Read
-  "hw-address"               gchar*                : Read
+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceOlpcMesh
@@ -88,255 +157,236 @@ NMDeviceOlpcMesh implements

-

Details

+

Functions

-

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;
-
-
+

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

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

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 -

connection

the DBusGConnection

 

NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION

the Olpc Mesh connection was invalid -

path

the DBus object path of the device

 
-
-
-

NM_DEVICE_OLPC_MESH_ERROR

-
#define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
-
-

-

+
+

Returns

+

a new OlpcMesh device.

+

[transfer full]

+
-

nm_device_olpc_mesh_error_quark ()

-
GQuark              nm_device_olpc_mesh_error_quark     (void);
-

-Registers an error quark for NMDeviceOlpcMesh if necessary. -

-
+

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

+
--+++ - - + + +

Returns :

the error quark used for NMDeviceOlpcMesh errors.

device

a NMDeviceOlpcMesh

 
-
-
-

NM_DEVICE_OLPC_MESH_HW_ADDRESS

-
#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
-
-

-

+
+

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_ACTIVE_CHANNEL

-
#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
-
-

-

+

nm_device_olpc_mesh_get_companion ()

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

Gets the companion device of the NMDeviceOlpcMesh.

+
+

Parameters

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

device

a NMDeviceOlpcMesh

 
+
+
+

Returns

+

the companion of the device of NULL.

+

[transfer none]

-
-
-

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;
-
-

-

+

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

 
-
+
+

Returns

+

active channel of the device

+

+
+
+
+
+

Types and Values

-

nm_device_olpc_mesh_new ()

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

-Creates a new NMDeviceOlpcMesh. -

-
+

enum NMDeviceOlpcMeshError

+
+

Members

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

connection :

the DBusGConnection +

NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN

 +

unknown or unclassified error

 

path :

the DBus object path of the device

NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION

 +

the connection was not of Olpc Mesh type

+		 

Returns :

a new OlpcMesh device. [transfer full] +

NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION

 +

the Olpc Mesh connection was invalid

 
+
-

nm_device_olpc_mesh_get_hw_address ()

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

NM_DEVICE_OLPC_MESH_ERROR

+
#define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
+

-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_get_companion ()

-
NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);
+

NM_DEVICE_OLPC_MESH_HW_ADDRESS

+
#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
+

-Gets the companion device of the NMDeviceOlpcMesh.

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

device :

a NMDeviceOlpcMesh -

Returns :

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

nm_device_olpc_mesh_get_active_channel ()

-
guint32             nm_device_olpc_mesh_get_active_channel
-                                                        (NMDeviceOlpcMesh *device);
+

NM_DEVICE_OLPC_MESH_COMPANION

+
#define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
+
+

+

+
+
+
+

NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

+
#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
+

-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                 : Read
-

-The device's active channel. -

+

The “active-channel” property

+
  “active-channel”           guint
+

+

Flags: Read

Default value: 0

-

The "companion" property

-
  "companion"                NMDeviceWifi*         : Read
-

-The companion device. -

+

The “companion” property

+
  “companion”                NMDeviceWifi *
+

+

Flags: Read

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
-

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

+

The “hw-address” property

+
  “hw-address”               gchar *
+

+

Flags: Read

Default value: NULL

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