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/html/NMDeviceWimax.html | 948 ++++++++++++++++++++----------------- 1 file changed, 511 insertions(+), 437 deletions(-) (limited to 'docs/libnm/html/NMDeviceWimax.html') diff --git a/docs/libnm/html/NMDeviceWimax.html b/docs/libnm/html/NMDeviceWimax.html index 2a97f81d..f1d58b57 100644 --- a/docs/libnm/html/NMDeviceWimax.html +++ b/docs/libnm/html/NMDeviceWimax.html @@ -2,38 +2,29 @@ -NMDeviceWimax +libnm Reference Manual: NMDeviceWimax - + - - - - - - - - - - + + + + + + +
@@ -41,557 +32,640 @@

NMDeviceWimax

NMDeviceWimax

- +
-
-

Synopsis

-
#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
-#define             NM_DEVICE_WIMAX_NSPS
-struct              NMDeviceWimax;
-                    NMDeviceWimaxClass;
-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.

+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
const char * + +nm_device_wimax_get_hw_address () +
+NMWimaxNsp * + +nm_device_wimax_get_active_nsp () +
+NMWimaxNsp * + +nm_device_wimax_get_nsp_by_path () +
const GPtrArray * + +nm_device_wimax_get_nsps () +
+guint + +nm_device_wimax_get_center_frequency () +
+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 () +

Properties

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

Signals

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

Description

-

-

-
-
-

Details

-
-

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

-

-
-
-
-

NM_DEVICE_WIMAX_NSPS

-
#define NM_DEVICE_WIMAX_NSPS             "nsps"
-
-

-

-
-
-
-

struct NMDeviceWimax

-
struct 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_get_hw_address ()

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

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

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

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. +GPtrArray *nspsRead
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 -#defineNM_DEVICE_WIMAX_HW_ADDRESS

path :

the object path of the NSP#defineNM_DEVICE_WIMAX_ACTIVE_NSP

Returns :

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

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

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

wimax :

a NMDeviceWimax -

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 NMWimaxNsp] -

path

the object path of the NSP

 
+
+

Returns

+

the access point or NULL if none is found.

+

[transfer none]

+
+
-

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 +

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 NMWimaxNsp]

+
+
+
+
+

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

-
+device is not connected.

+
+

Parameters

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

self :

a NMDeviceWimax -

Returns :

the center frequency in KHz, or 0

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 +

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 -

self

a NMDeviceWimax

 
+
+

Returns

+

the ID of the serving Base Station, or NULL

+

+
+
-

Property Details

+

Types and Values

-

The "active-nsp" property

-
  "active-nsp"               NMWimaxNsp*           : Read
+

NM_DEVICE_WIMAX_HW_ADDRESS

+
#define NM_DEVICE_WIMAX_HW_ADDRESS       "hw-address"
+

-The active NMWimaxNsp of the device.

-

The "bsid" property

-
  "bsid"                     gchar*                : Read
+

NM_DEVICE_WIMAX_ACTIVE_NSP

+
#define NM_DEVICE_WIMAX_ACTIVE_NSP       "active-nsp"
+

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

+
#define NM_DEVICE_WIMAX_CENTER_FREQUENCY "center-frequency"
+

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

+
#define NM_DEVICE_WIMAX_RSSI             "rssi"
+

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

+
#define NM_DEVICE_WIMAX_CINR             "cinr"
+

-The hardware (MAC) address of the device.

-

Default value: NULL

-

The "nsps" property

-
  "nsps"                     GPtrArray*            : Read
+

NM_DEVICE_WIMAX_TX_POWER

+
#define NM_DEVICE_WIMAX_TX_POWER         "tx-power"
+

-List of all WiMAX Network Service Providers the device can see.

+
+
+
+

NM_DEVICE_WIMAX_BSID

+
#define NM_DEVICE_WIMAX_BSID             "bsid"
+

-Element-type: NMWimaxNsp

-

The "rssi" property

-
  "rssi"                     gint                  : Read
+

NM_DEVICE_WIMAX_NSPS

+
#define NM_DEVICE_WIMAX_NSPS             "nsps"
+

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

+
+
+
+

Property Details

+
+

The “active-nsp” property

+
  “active-nsp”               NMWimaxNsp *
+

+

Flags: Read

+
+
+
+

The “bsid” property

+
  “bsid”                     gchar *
+

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “center-frequency” property

+
  “center-frequency”         guint
+

+

Flags: Read

Default value: 0

-

The "tx-power" property

-
  "tx-power"                 gint                  : Read
-

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

+

The “cinr” property

+
  “cinr”                     gint
+

+

Flags: Read

+

Default value: 0

+
+
+
+

The “hw-address” property

+
  “hw-address”               gchar *
+

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “nsps” property

+
  “nsps”                     GPtrArray *
+

+

Flags: Read

+
+
+
+

The “rssi” property

+
  “rssi”                     gint
+

+

Flags: Read

+

Default value: 0

+
+
+
+

The “tx-power” property

+
  “tx-power”                 gint
+

+

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.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5