system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-22 10:46:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

libnm-util: update WiMAX setting documentation

Browse source
This commit is contained in:
Dan Williams 2011-07-02 15:38:27 -05:00
parent af55e25f14
commit 2943453bf8
2 changed files with 49 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
libnm-util/nm-setting-wimax.c
View file

@ -27,6 +27,22 @@
#include "nm-setting-wimax.h"
#include "nm-param-spec-specialized.h"
/**
* SECTION:nm-setting-wimax
* @short_description: Describes 802.16e Mobile WiMAX connection properties
* @include: nm-setting-wimax.h
*
* The #NMSettingWimax object is a #NMSetting subclass that describes properties
* necessary for connection to 802.16e Mobile WiMAX networks.
**/
/**
* nm_setting_wimax_error_quark:
*
* Registers an error quark for #NMSettingWimax if necessary.
*
* Returns: the error quark used for #NMSettingWimax errors.
**/
GQuark
nm_setting_wimax_error_quark (void)
{
@ -78,12 +94,28 @@ enum {
LAST_PROP
};
/**
* nm_setting_wimax_new:
*
* Creates a new #NMSettingWimax object with default values.
*
* Returns: the new empty #NMSettingWimax object
**/
NMSetting *
nm_setting_wimax_new (void)
{
return (NMSetting *) g_object_new (NM_TYPE_SETTING_WIMAX, NULL);
}
/**
* nm_setting_wimax_get_network_name:
* @setting: the #NMSettingWimax
*
* Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the
* specific WiMAX network this setting describes a connection to.
*
* Returns: the WiMAX NSP name
**/
const char *
nm_setting_wimax_get_network_name (NMSettingWimax *setting)
{
@ -92,6 +124,15 @@ nm_setting_wimax_get_network_name (NMSettingWimax *setting)
return NM_SETTING_WIMAX_GET_PRIVATE (setting)->network_name;
}
/**
* nm_setting_wimax_get_mac_address:
* @setting: the #NMSettingWimax
*
* Returns the MAC address of a WiMAX device which this connection is locked
* to.
*
* Returns: the MAC address
**/
const GByteArray *
nm_setting_wimax_get_mac_address (NMSettingWimax *setting)
{

10
libnm-util/nm-setting-wimax.h
View file

@ -35,8 +35,14 @@ G_BEGIN_DECLS
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
typedef enum
{
/**
* 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
*/
typedef enum {
NM_SETTING_WIMAX_ERROR_UNKNOWN = 0,
NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY,
NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY