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;

NM_SETTING_WIMAX_ERROR_UNKNOWN

 unknown or unclassified error

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

 the property was invalid

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

 the property was missing and is required

NM_SETTING_WIMAX_ERROR

#define NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark ()

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.

NM_SETTING_WIMAX_NETWORK_NAME

#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"

NM_SETTING_WIMAX_MAC_ADDRESS

#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"

NMSettingWimax

typedef struct _NMSettingWimax NMSettingWimax;

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

setting :

 the NMSettingWimax

Returns :

 the WiMAX NSP name

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.

setting :

 the NMSettingWimax

Returns :

 the MAC address

Property Details

The "mac-address" property

  "mac-address"              GArray_guchar_*       : Read / Write

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

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

Default value: NULL

Generated by GTK-Doc V1.19