From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-glib/html/NMDeviceWimax.html | 1075 +++++++++++++++++-------------- 1 file changed, 584 insertions(+), 491 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceWimax.html') diff --git a/docs/libnm-glib/html/NMDeviceWimax.html b/docs/libnm-glib/html/NMDeviceWimax.html index 5cd1c4de..c496a2c6 100644 --- a/docs/libnm-glib/html/NMDeviceWimax.html +++ b/docs/libnm-glib/html/NMDeviceWimax.html @@ -2,38 +2,29 @@ -NMDeviceWimax +libnm-glib Reference Manual: NMDeviceWimax - + - - - - - - - - - - + + + + + + +
@@ -41,643 +32,745 @@

NMDeviceWimax

NMDeviceWimax

- +
-
-

Synopsis

-
enum                NMDeviceWimaxError;
-#define             NM_DEVICE_WIMAX_ERROR
-GQuark              nm_device_wimax_error_quark         (void);
-#define             NM_DEVICE_WIMAX_HW_ADDRESS
-#define             NM_DEVICE_WIMAX_ACTIVE_NSP
-#define             NM_DEVICE_WIMAX_CENTER_FREQUENCY
-#define             NM_DEVICE_WIMAX_RSSI
-#define             NM_DEVICE_WIMAX_CINR
-#define             NM_DEVICE_WIMAX_TX_POWER
-#define             NM_DEVICE_WIMAX_BSID
-                    NMDeviceWimax;
-                    NMDeviceWimaxClass;
-GObject *           nm_device_wimax_new                 (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_wimax_get_hw_address      (NMDeviceWimax *wimax);
-NMWimaxNsp *        nm_device_wimax_get_active_nsp      (NMDeviceWimax *wimax);
-NMWimaxNsp *        nm_device_wimax_get_nsp_by_path     (NMDeviceWimax *wimax,
-                                                         const char *path);
-const GPtrArray *   nm_device_wimax_get_nsps            (NMDeviceWimax *wimax);
-guint               nm_device_wimax_get_center_frequency
-                                                        (NMDeviceWimax *self);
-gint                nm_device_wimax_get_rssi            (NMDeviceWimax *self);
-gint                nm_device_wimax_get_cinr            (NMDeviceWimax *self);
-gint                nm_device_wimax_get_tx_power        (NMDeviceWimax *self);
-const char *        nm_device_wimax_get_bsid            (NMDeviceWimax *self);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceWimax
-
-
-
-

Implemented Interfaces

-

-NMDeviceWimax implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "active-nsp"               NMWimaxNsp*           : Read
-  "bsid"                     gchar*                : Read
-  "center-frequency"         guint                 : Read
-  "cinr"                     gint                  : Read
-  "hw-address"               gchar*                : Read
-  "rssi"                     gint                  : Read
-  "tx-power"                 gint                  : Read
-
-
-

Signals

-
-  "nsp-added"                                      : Run First
-  "nsp-removed"                                    : Run First
-
-
-
-

Description

-

-

-
-
-

Details

-
-

enum NMDeviceWimaxError

-
typedef enum {
-	NM_DEVICE_WIMAX_ERROR_UNKNOWN = 0,              /*< nick=UnknownError >*/
-	NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION,     /*< nick=NotWimaxConnection >*/
-	NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION, /*< nick=InvalidWimaxConnection >*/
-	NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC,       /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH,             /*< nick=MacMismatch >*/
-} NMDeviceWimaxError;
-
-
+

Functions

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

NM_DEVICE_WIMAX_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_device_wimax_error_quark ()

NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION

the connection was not of WiMax type + +GObject * + +nm_device_wimax_new ()

NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION

the WiMax connection was invalid +const char * + +nm_device_wimax_get_hw_address ()

NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC

the device's MAC was invalid + +NMWimaxNsp * + +nm_device_wimax_get_active_nsp ()

NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH

the MACs of the connection and the device mismatched + +NMWimaxNsp * + +nm_device_wimax_get_nsp_by_path ()
-
-
-
-

NM_DEVICE_WIMAX_ERROR

-
#define NM_DEVICE_WIMAX_ERROR nm_device_wimax_error_quark ()
-
-

-

-
-
-
-

nm_device_wimax_error_quark ()

-
GQuark              nm_device_wimax_error_quark         (void);
-

-Registers an error quark for NMDeviceWimax if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMDeviceWimax errors.
-
-
-
-

NM_DEVICE_WIMAX_HW_ADDRESS

-
#define NM_DEVICE_WIMAX_HW_ADDRESS       "hw-address"
-
-

-

-
-
-
-

NM_DEVICE_WIMAX_ACTIVE_NSP

-
#define NM_DEVICE_WIMAX_ACTIVE_NSP       "active-nsp"
-
-

-

-
-
-
-

NM_DEVICE_WIMAX_CENTER_FREQUENCY

-
#define NM_DEVICE_WIMAX_CENTER_FREQUENCY "center-frequency"
-
-

-

-
-
-
-

NM_DEVICE_WIMAX_RSSI

-
#define NM_DEVICE_WIMAX_RSSI             "rssi"
-
-

-

-
-
-
-

NM_DEVICE_WIMAX_CINR

-
#define NM_DEVICE_WIMAX_CINR             "cinr"
-
-

-

-
-
-
-

NM_DEVICE_WIMAX_TX_POWER

-
#define NM_DEVICE_WIMAX_TX_POWER         "tx-power"
-
-

-

-
-
-
-

NM_DEVICE_WIMAX_BSID

-
#define NM_DEVICE_WIMAX_BSID             "bsid"
-
-

-

-
-
-
-

NMDeviceWimax

-
typedef struct _NMDeviceWimax NMDeviceWimax;
-

-

-
-
-
-

NMDeviceWimaxClass

-
typedef struct {
-	NMDeviceClass parent;
-
-	/* Signals */
-	void (*nsp_added)   (NMDeviceWimax *self, NMWimaxNsp *nsp);
-	void (*nsp_removed) (NMDeviceWimax *self, NMWimaxNsp *nsp);
-} NMDeviceWimaxClass;
-
-

-

-
-
-
-

nm_device_wimax_new ()

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

-Creates a new NMDeviceWimax. -

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

connection :

the DBusGConnection +const GPtrArray * + +nm_device_wimax_get_nsps ()

path :

the D-Bus object path of the WiMAX device +guint + +nm_device_wimax_get_center_frequency () +

Returns :

a new WiMAX device. [transfer full] + +gint + +nm_device_wimax_get_rssi () +
+gint + +nm_device_wimax_get_cinr () +
+gint + +nm_device_wimax_get_tx_power () +
const char * + +nm_device_wimax_get_bsid ()
-
-
-

nm_device_wimax_get_hw_address ()

-
const char *        nm_device_wimax_get_hw_address      (NMDeviceWimax *wimax);
-

-Gets the hardware (MAC) address of the NMDeviceWimax -

-
+
+

Properties

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

wimax :

a NMDeviceWimax - +NMWimaxNsp *active-nspRead
+gchar *bsidRead
guintcenter-frequencyRead
gintcinrRead
+gchar *hw-addressRead

Returns :

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

nm_device_wimax_get_active_nsp ()

-
NMWimaxNsp *        nm_device_wimax_get_active_nsp      (NMDeviceWimax *wimax);
-

-Gets the active NMWimaxNsp. -

-
+
+

Signals

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

wimax :

a NMDeviceWimax -voidnsp-addedRun First

Returns :

the access point or NULL if none is active. [transfer full] -voidnsp-removedRun First
-
-
-

nm_device_wimax_get_nsp_by_path ()

-
NMWimaxNsp *        nm_device_wimax_get_nsp_by_path     (NMDeviceWimax *wimax,
-                                                         const char *path);
-

-Gets a NMWimaxNsp by path. -

-
+
+

Types and Values

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

wimax :

a NMDeviceWimax -enumNMDeviceWimaxError

path :

the object path of the NSP#defineNM_DEVICE_WIMAX_ERROR

Returns :

the access point or NULL if none is found. [transfer none] -#defineNM_DEVICE_WIMAX_HW_ADDRESS
#defineNM_DEVICE_WIMAX_ACTIVE_NSP
#defineNM_DEVICE_WIMAX_CENTER_FREQUENCY
#defineNM_DEVICE_WIMAX_RSSI
#defineNM_DEVICE_WIMAX_CINR
#defineNM_DEVICE_WIMAX_TX_POWER
#defineNM_DEVICE_WIMAX_BSID
-
-
-

nm_device_wimax_get_nsps ()

-
const GPtrArray *   nm_device_wimax_get_nsps            (NMDeviceWimax *wimax);
+
+

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceWimax
+
+
+
+

Description

-Gets all the scanned NSPs of the NMDeviceWimax.

-
+ +
+

Functions

+
+

nm_device_wimax_error_quark ()

+
GQuark
+nm_device_wimax_error_quark (void);
+

Registers an error quark for NMDeviceWimax if necessary.

+
+

Returns

+

the error quark used for NMDeviceWimax errors.

+

+
+
+
+
+

nm_device_wimax_new ()

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

Creates a new NMDeviceWimax.

+
+

Parameters

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

wimax :

a NMDeviceWimax -

connection

the DBusGConnection

 

Returns :

a GPtrArray containing -all the scanned NMWimaxNsps. -The returned array is owned by the client and should not be modified. [element-type NMClient.WimaxNsp] -

path

the D-Bus object path of the WiMAX device

 
+
+

Returns

+

a new WiMAX device.

+

[transfer full]

+
+
-

nm_device_wimax_get_center_frequency ()

-
guint               nm_device_wimax_get_center_frequency
-                                                        (NMDeviceWimax *self);
-

-Gets the center frequency (in KHz) of the radio channel the device is using -to communicate with the network when connected. Has no meaning when the -device is not connected. -

-
+

nm_device_wimax_get_hw_address ()

+
const char *
+nm_device_wimax_get_hw_address (NMDeviceWimax *wimax);
+

Gets the hardware (MAC) address of the NMDeviceWimax

+
+

Parameters

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

wimax

a NMDeviceWimax

 
+
+
+

Returns

+

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

+

+
+
+
+
+

nm_device_wimax_get_active_nsp ()

+
NMWimaxNsp *
+nm_device_wimax_get_active_nsp (NMDeviceWimax *wimax);
+

Gets the active NMWimaxNsp.

+
+

Parameters

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

wimax

a NMDeviceWimax

 
+
+
+

Returns

+

the access point or NULL if none is active.

+

[transfer full]

+
+
+
+
+

nm_device_wimax_get_nsp_by_path ()

+
NMWimaxNsp *
+nm_device_wimax_get_nsp_by_path (NMDeviceWimax *wimax,
+                                 const char *path);
+

Gets a NMWimaxNsp by path.

+
+

Parameters

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

self :

a NMDeviceWimax -

wimax

a NMDeviceWimax

 

Returns :

the center frequency in KHz, or 0

path

the object path of the NSP

 
+
+

Returns

+

the access point or NULL if none is found.

+

[transfer none]

+
+
-

nm_device_wimax_get_rssi ()

-
gint                nm_device_wimax_get_rssi            (NMDeviceWimax *self);
-

-Gets the RSSI of the current radio link in dBm. This value indicates how +

nm_device_wimax_get_nsps ()

+
const GPtrArray *
+nm_device_wimax_get_nsps (NMDeviceWimax *wimax);
+

Gets all the scanned NSPs of the NMDeviceWimax.

+
+

Parameters

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

wimax

a NMDeviceWimax

 
+
+
+

Returns

+

a GPtrArray containing +all the scanned NMWimaxNsps. +The returned array is owned by the client and should not be modified.

+

[element-type NMClient.WimaxNsp]

+
+
+
+
+

nm_device_wimax_get_center_frequency ()

+
guint
+nm_device_wimax_get_center_frequency (NMDeviceWimax *self);
+

Gets the center frequency (in KHz) of the radio channel the device is using +to communicate with the network when connected. Has no meaning when the +device is not connected.

+
+

Parameters

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

self

a NMDeviceWimax

 
+
+
+

Returns

+

the center frequency in KHz, or 0

+

+
+
+
+
+

nm_device_wimax_get_rssi ()

+
gint
+nm_device_wimax_get_rssi (NMDeviceWimax *self);
+

Gets the RSSI of the current radio link in dBm. This value indicates how strong the raw received RF signal from the base station is, but does not indicate the overall quality of the radio link. Has no meaning when the -device is not connected. -

-
+device is not connected.

+
+

Parameters

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

self :

a NMDeviceWimax -

Returns :

the RSSI in dBm, or 0

self

a NMDeviceWimax

 
+
+

Returns

+

the RSSI in dBm, or 0

+

+
+
-

nm_device_wimax_get_cinr ()

-
gint                nm_device_wimax_get_cinr            (NMDeviceWimax *self);
-

-Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio +

nm_device_wimax_get_cinr ()

+
gint
+nm_device_wimax_get_cinr (NMDeviceWimax *self);
+

Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio link in dB. CINR is a more accurate measure of radio link quality. Has no -meaning when the device is not connected. -

-
+meaning when the device is not connected.

+
+

Parameters

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

self :

a NMDeviceWimax -

Returns :

the CINR in dB, or 0

self

a NMDeviceWimax

 
+
+

Returns

+

the CINR in dB, or 0

+

+
+
-

nm_device_wimax_get_tx_power ()

-
gint                nm_device_wimax_get_tx_power        (NMDeviceWimax *self);
-

-Average power of the last burst transmitted by the device, in units of +

nm_device_wimax_get_tx_power ()

+
gint
+nm_device_wimax_get_tx_power (NMDeviceWimax *self);
+

Average power of the last burst transmitted by the device, in units of 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of --5.5 dBm. Has no meaning when the device is not connected. -

-
+-5.5 dBm. Has no meaning when the device is not connected.

+
+

Parameters

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

self :

a NMDeviceWimax -

Returns :

the TX power in dBm, or 0

self

a NMDeviceWimax

 
+
+

Returns

+

the TX power in dBm, or 0

+

+
+
-

nm_device_wimax_get_bsid ()

-
const char *        nm_device_wimax_get_bsid            (NMDeviceWimax *self);
-

-Gets the ID of the serving Base Station when the device is connected. -

-
+

nm_device_wimax_get_bsid ()

+
const char *
+nm_device_wimax_get_bsid (NMDeviceWimax *self);
+

Gets the ID of the serving Base Station when the device is connected.

+
+

Parameters

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

self

a NMDeviceWimax

 
+
+
+

Returns

+

the ID of the serving Base Station, or NULL

+

+
+ + +
+

Types and Values

+
+

enum NMDeviceWimaxError

+
+

Members

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

self :

a NMDeviceWimax +

NM_DEVICE_WIMAX_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

the ID of the serving Base Station, or NULL +

NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION

 +

the connection was not of WiMax type

 

NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION

 +

the WiMax connection was invalid

+		 

NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC

 +

the device's MAC was invalid

+		 

NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH

 +

the MACs of the connection and the device mismatched

+		 
-
-

Property Details

+
-

The "active-nsp" property

-
  "active-nsp"               NMWimaxNsp*           : Read
+

NM_DEVICE_WIMAX_ERROR

+
#define NM_DEVICE_WIMAX_ERROR nm_device_wimax_error_quark ()
+

-The active NMWimaxNsp of the device.

-

The "bsid" property

-
  "bsid"                     gchar*                : Read
+

NM_DEVICE_WIMAX_HW_ADDRESS

+
#define NM_DEVICE_WIMAX_HW_ADDRESS       "hw-address"
+

-The ID of the serving base station as received from the network. Has -no meaning when the device is not connected.

-

Default value: NULL

-

The "center-frequency" property

-
  "center-frequency"         guint                 : Read
+

NM_DEVICE_WIMAX_ACTIVE_NSP

+
#define NM_DEVICE_WIMAX_ACTIVE_NSP       "active-nsp"
+

-The center frequency (in KHz) of the radio channel the device is using to -communicate with the network when connected. Has no meaning when the -device is not connected.

-

Default value: 0

-

The "cinr" property

-
  "cinr"                     gint                  : Read
+

NM_DEVICE_WIMAX_CENTER_FREQUENCY

+
#define NM_DEVICE_WIMAX_CENTER_FREQUENCY "center-frequency"
+

-CINR (Carrier to Interference + Noise Ratio) of the current radio link -in dB. CINR is a more accurate measure of radio link quality. Has no -meaning when the device is not connected.

-

Default value: 0

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
+

NM_DEVICE_WIMAX_RSSI

+
#define NM_DEVICE_WIMAX_RSSI             "rssi"
+

-The hardware (MAC) address of the device.

-

Default value: NULL

-

The "rssi" property

-
  "rssi"                     gint                  : Read
+

NM_DEVICE_WIMAX_CINR

+
#define NM_DEVICE_WIMAX_CINR             "cinr"
+

-RSSI of the current radio link in dBm. This value indicates how strong -the raw received RF signal from the base station is, but does not -indicate the overall quality of the radio link. Has no meaning when the -device is not connected.

-

Default value: 0

-

The "tx-power" property

-
  "tx-power"                 gint                  : Read
+

NM_DEVICE_WIMAX_TX_POWER

+
#define NM_DEVICE_WIMAX_TX_POWER         "tx-power"
+
+

+

+
+
+
+

NM_DEVICE_WIMAX_BSID

+
#define NM_DEVICE_WIMAX_BSID             "bsid"
+

-Average power of the last burst transmitted by the device, in units of -0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of --5.5 dBm. Has no meaning when the device is not connected.

+
+
+
+

Property Details

+
+

The “active-nsp” property

+
  “active-nsp”               NMWimaxNsp *
+

Active NSP.

+

Flags: Read

+
+
+
+

The “bsid” property

+
  “bsid”                     gchar *
+

BSID.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “center-frequency” property

+
  “center-frequency”         guint
+

Center frequency.

+

Flags: Read

+

Default value: 0

+
+
+
+

The “cinr” property

+
  “cinr”                     gint
+

CINR.

+

Flags: Read

+

Default value: 0

+
+
+
+

The “hw-address” property

+
  “hw-address”               gchar *
+

Hardware MAC address.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “rssi” property

+
  “rssi”                     gint
+

RSSI.

+

Flags: Read

+

Default value: 0

+
+
+
+

The “tx-power” property

+
  “tx-power”                 gint
+

TX Power.

+

Flags: Read

Default value: 0

Signal Details

-

The "nsp-added" signal

-
void                user_function                      (NMDeviceWimax *self,
-                                                        GObject       *nsp,
-                                                        gpointer       user_data)      : Run First
-

-Notifies that a NMWimaxNsp is added to the wimax device. -

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

self :

the wimax device that received the signal

nsp :

the new NSP

user_data :

user data set when the signal handler was connected.
+

The “nsp-added” signal

+
void
+user_function (NMDeviceWimax *self,
+               GObject       *nsp,
+               gpointer       user_data)
+

Flags: Run First

-

The "nsp-removed" signal

-
void                user_function                      (NMDeviceWimax *self,
-                                                        GObject       *nsp,
-                                                        gpointer       user_data)      : Run First
-

-Notifies that a NMWimaxNsp is removed from the wimax device. -

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

self :

the wimax device that received the signal

nsp :

the removed NSP

user_data :

user data set when the signal handler was connected.
+

The “nsp-removed” signal

+
void
+user_function (NMDeviceWimax *self,
+               GObject       *nsp,
+               gpointer       user_data)
+

Flags: Run First

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