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-util/html/NMSettingWimax.html | 423 +++++++++++++++++-------------- 1 file changed, 232 insertions(+), 191 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWimax.html') diff --git a/docs/libnm-util/html/NMSettingWimax.html b/docs/libnm-util/html/NMSettingWimax.html index ce31e8ec..6d0035fb 100644 --- a/docs/libnm-util/html/NMSettingWimax.html +++ b/docs/libnm-util/html/NMSettingWimax.html @@ -2,34 +2,28 @@ -NMSettingWimax +libnm-util Reference Manual: NMSettingWimax - + - - - - - - - - - - + + + + + + +
@@ -37,250 +31,297 @@

NMSettingWimax

NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties

- +
-
-

Synopsis

-
-#include <nm-setting-wimax.h>
-
-#define             NM_SETTING_WIMAX_SETTING_NAME
-enum                NMSettingWimaxError;
-#define             NM_SETTING_WIMAX_ERROR
-GQuark              nm_setting_wimax_error_quark        (void);
-#define             NM_SETTING_WIMAX_NETWORK_NAME
-#define             NM_SETTING_WIMAX_MAC_ADDRESS
-                    NMSettingWimax;
-                    NMSettingWimaxClass;
-NMSetting *         nm_setting_wimax_new                (void);
-const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
-const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingWimaxError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingWimax
-
-
-
-

Properties

-
-  "mac-address"              GArray_guchar_*       : Read / Write
-  "network-name"             gchar*                : Read / Write
-
-
-
-

Description

-

-The NMSettingWimax object is a NMSetting subclass that describes properties -necessary for connection to 802.16e Mobile WiMAX networks. -

-
-

Details

-
-

NM_SETTING_WIMAX_SETTING_NAME

-
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
-
-

-

-
-
-
-

enum NMSettingWimaxError

-
typedef enum {
-	NM_SETTING_WIMAX_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSettingWimaxError;
-
-
+

Functions

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

NM_SETTING_WIMAX_ERROR_UNKNOWN

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

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

the property was invalid + +NMSetting * + +nm_setting_wimax_new ()

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

the property was missing and is -required +const char * + +nm_setting_wimax_get_network_name () +
const GByteArray * + +nm_setting_wimax_get_mac_address ()
-
-
-

NM_SETTING_WIMAX_ERROR

-
#define NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + +
+GArray_guchar_ *mac-addressRead / Write
+gchar *network-nameRead / Write
-
-
-

nm_setting_wimax_error_quark ()

-
GQuark              nm_setting_wimax_error_quark        (void);
-

-Registers an error quark for NMSettingWimax if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingWimax errors.
#defineNM_SETTING_WIMAX_SETTING_NAME
enumNMSettingWimaxError
#defineNM_SETTING_WIMAX_ERROR
#defineNM_SETTING_WIMAX_NETWORK_NAME
#defineNM_SETTING_WIMAX_MAC_ADDRESS
-
-
-

NM_SETTING_WIMAX_NETWORK_NAME

-
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingWimaxError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingWimax
 

-

-

 

-

-

-
NM_SETTING_WIMAX_MAC_ADDRESS

-
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
+

+
Includes

+
#include <nm-setting-wimax.h>
 

-

-

 

-

+

+
Description

+
The NMSettingWimax object is a NMSetting subclass that describes properties
+necessary for connection to 802.16e Mobile WiMAX networks.

+

+

+
Functions

 

-
NMSettingWimax

-
typedef struct _NMSettingWimax NMSettingWimax;

-

-

+
nm_setting_wimax_error_quark ()

+
GQuark
+nm_setting_wimax_error_quark (void);

+
Registers an error quark for NMSettingWimax if necessary.

+

+
Returns

+
 the error quark used for NMSettingWimax errors.

+

+

 

 

 

-
NMSettingWimaxClass

-
typedef struct {
-	NMSettingClass parent;
-} NMSettingWimaxClass;
-

-

-

+
nm_setting_wimax_new ()

+
NMSetting *
+nm_setting_wimax_new (void);

+
Creates a new NMSettingWimax object with default values.

+

+
Returns

+
 the new empty NMSettingWimax object

+

+

 

 

 

-
nm_setting_wimax_new ()

-
NMSetting *         nm_setting_wimax_new                (void);

-

-Creates a new NMSettingWimax object with default values.
-

-

+
nm_setting_wimax_get_network_name ()

+
const char *
+nm_setting_wimax_get_network_name (NMSettingWimax *setting);

+
Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the
+specific WiMAX network this setting describes a connection to.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingWimax object
setting
the NMSettingWimax
 
 

 

 

+

+
Returns

+
 the WiMAX NSP name

+

+

+

 

 

-
nm_setting_wimax_get_network_name ()

-
const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);

-

-Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the
-specific WiMAX network this setting describes a connection to.
-

-

+
nm_setting_wimax_get_mac_address ()

+
const GByteArray *
+nm_setting_wimax_get_mac_address (NMSettingWimax *setting);

+
Returns the MAC address of a WiMAX device which this connection is locked
+to.

+

+
Parameters

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

 





 
setting :
the NMSettingWimax
-
Returns :
the WiMAX NSP name
setting
the NMSettingWimax
 

 

 

-

+

+
Returns

+
 the MAC address

+

+

+

+
+
+

Types and Values

-

nm_setting_wimax_get_mac_address ()

-
const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

NM_SETTING_WIMAX_SETTING_NAME

+
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
+

-Returns the MAC address of a WiMAX device which this connection is locked -to.

-
+ +
+
+

enum NMSettingWimaxError

+
+

Members

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

setting :

the NMSettingWimax +

NM_SETTING_WIMAX_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

the MAC address

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

 +

the property was invalid

+		 

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 
-
-

Property Details

+
+
+

NM_SETTING_WIMAX_ERROR

+
#define NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark ()
+
+

+

+
+
-

The "mac-address" property

-
  "mac-address"              GArray_guchar_*       : Read / Write
+

NM_SETTING_WIMAX_NETWORK_NAME

+
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
+

-If specified, this connection will only apply to the WiMAX device whose -MAC address matches. This property does not change the MAC address of the -device (known as MAC spoofing).

-

The "network-name" property

-
  "network-name"             gchar*                : Read / Write
+

NM_SETTING_WIMAX_MAC_ADDRESS

+
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
+

-Network Service Provider (NSP) name of the WiMAX network this connection -should use.

+
+
+
+

Property Details

+
+

The “mac-address” property

+
  “mac-address”              GArray_guchar_ *
+

+

Flags: Read / Write

+
+
+
+

The “network-name” property

+
  “network-name”             gchar *
+

+

Flags: Read / Write

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