libnm-util: add setting accessor helpers (bgo #644746)

Makes code cleaner.
This commit is contained in:
Dan Williams 2011-03-15 10:32:42 -05:00
parent b224ab8e56
commit 27e7177ec4
3 changed files with 304 additions and 0 deletions

View file

@ -14,6 +14,21 @@ global:
nm_connection_get_path;
nm_connection_get_setting;
nm_connection_get_setting_by_name;
nm_connection_get_setting_802_1x;
nm_connection_get_setting_bluetooth;
nm_connection_get_setting_cdma;
nm_connection_get_setting_connection;
nm_connection_get_setting_gsm;
nm_connection_get_setting_ip4_config;
nm_connection_get_setting_ip6_config;
nm_connection_get_setting_olpc_mesh;
nm_connection_get_setting_ppp;
nm_connection_get_setting_pppoe;
nm_connection_get_setting_vpn;
nm_connection_get_setting_wimax;
nm_connection_get_setting_wired;
nm_connection_get_setting_wireless;
nm_connection_get_setting_wireless_security;
nm_connection_get_uuid;
nm_connection_get_type;
nm_connection_lookup_setting_type;

View file

@ -1177,6 +1177,263 @@ nm_connection_get_id (NMConnection *connection)
/*************************************************************/
/**
* nm_connection_get_setting_802_1x:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSetting8021x the connection might contain.
*
* Returns: an #NMSetting8021x if the connection contains one, otherwise NULL
**/
NMSetting8021x *
nm_connection_get_setting_802_1x (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSetting8021x *) nm_connection_get_setting (connection, NM_TYPE_SETTING_802_1X);
}
/**
* nm_connection_get_setting_bluetooth:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingBluetooth the connection might contain.
*
* Returns: an #NMSettingBluetooth if the connection contains one, otherwise NULL
**/
NMSettingBluetooth *
nm_connection_get_setting_bluetooth (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingBluetooth *) nm_connection_get_setting (connection, NM_TYPE_SETTING_BLUETOOTH);
}
/**
* nm_connection_get_setting_cdma:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingCdma the connection might contain.
*
* Returns: an #NMSettingCdma if the connection contains one, otherwise NULL
**/
NMSettingCdma *
nm_connection_get_setting_cdma (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingCdma *) nm_connection_get_setting (connection, NM_TYPE_SETTING_CDMA);
}
/**
* nm_connection_get_setting_connection:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingConnection the connection might contain.
*
* Returns: an #NMSettingConnection if the connection contains one, otherwise NULL
**/
NMSettingConnection *
nm_connection_get_setting_connection (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingConnection *) nm_connection_get_setting (connection, NM_TYPE_SETTING_CONNECTION);
}
/**
* nm_connection_get_setting_gsm:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingGsm the connection might contain.
*
* Returns: an #NMSettingGsm if the connection contains one, otherwise NULL
**/
NMSettingGsm *
nm_connection_get_setting_gsm (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingGsm *) nm_connection_get_setting (connection, NM_TYPE_SETTING_GSM);
}
/**
* nm_connection_get_setting_ip4_config:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingIP4Config the connection might contain.
*
* Returns: an #NMSettingIP4Config if the connection contains one, otherwise NULL
**/
NMSettingIP4Config *
nm_connection_get_setting_ip4_config (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingIP4Config *) nm_connection_get_setting (connection, NM_TYPE_SETTING_IP4_CONFIG);
}
/**
* nm_connection_get_setting_ip6_config:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingIP6Config the connection might contain.
*
* Returns: an #NMSettingIP6Config if the connection contains one, otherwise NULL
**/
NMSettingIP6Config *
nm_connection_get_setting_ip6_config (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingIP6Config *) nm_connection_get_setting (connection, NM_TYPE_SETTING_IP6_CONFIG);
}
/**
* nm_connection_get_setting_olpc_mesh:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingOlpcMesh the connection might contain.
*
* Returns: an #NMSettingOlpcMesh if the connection contains one, otherwise NULL
**/
NMSettingOlpcMesh *
nm_connection_get_setting_olpc_mesh (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingOlpcMesh *) nm_connection_get_setting (connection, NM_TYPE_SETTING_OLPC_MESH);
}
/**
* nm_connection_get_setting_ppp:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingPPP the connection might contain.
*
* Returns: an #NMSettingPPP if the connection contains one, otherwise NULL
**/
NMSettingPPP *
nm_connection_get_setting_ppp (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingPPP *) nm_connection_get_setting (connection, NM_TYPE_SETTING_PPP);
}
/**
* nm_connection_get_setting_pppoe:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingPPOE the connection might contain.
*
* Returns: an #NMSettingPPPOE if the connection contains one, otherwise NULL
**/
NMSettingPPPOE *
nm_connection_get_setting_pppoe (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingPPPOE *) nm_connection_get_setting (connection, NM_TYPE_SETTING_PPPOE);
}
/**
* nm_connection_get_setting_vpn:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingVPN the connection might contain.
*
* Returns: an #NMSettingVPN if the connection contains one, otherwise NULL
**/
NMSettingVPN *
nm_connection_get_setting_vpn (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingVPN *) nm_connection_get_setting (connection, NM_TYPE_SETTING_VPN);
}
/**
* nm_connection_get_setting_wimax:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingWimax the connection might contain.
*
* Returns: an #NMSettingWimax if the connection contains one, otherwise NULL
**/
NMSettingWimax *
nm_connection_get_setting_wimax (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingWimax *) nm_connection_get_setting (connection, NM_TYPE_SETTING_WIMAX);
}
/**
* nm_connection_get_setting_wired:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingWired the connection might contain.
*
* Returns: an #NMSettingWired if the connection contains one, otherwise NULL
**/
NMSettingWired *
nm_connection_get_setting_wired (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingWired *) nm_connection_get_setting (connection, NM_TYPE_SETTING_WIRED);
}
/**
* nm_connection_get_setting_wireless:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingWireless the connection might contain.
*
* Returns: an #NMSettingWireless if the connection contains one, otherwise NULL
**/
NMSettingWireless *
nm_connection_get_setting_wireless (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingWireless *) nm_connection_get_setting (connection, NM_TYPE_SETTING_WIRELESS);
}
/**
* nm_connection_get_setting_wireless_security:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingWirelessSecurity the connection might contain.
*
* Returns: an #NMSettingWirelessSecurity if the connection contains one, otherwise NULL
**/
NMSettingWirelessSecurity *
nm_connection_get_setting_wireless_security (NMConnection *connection)
{
g_return_val_if_fail (connection != NULL, NULL);
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingWirelessSecurity *) nm_connection_get_setting (connection, NM_TYPE_SETTING_WIRELESS_SECURITY);
}
/*************************************************************/
static void
nm_connection_init (NMConnection *connection)
{

View file

@ -30,6 +30,22 @@
#include <glib-object.h>
#include <nm-setting.h>
#include <nm-setting-8021x.h>
#include <nm-setting-bluetooth.h>
#include <nm-setting-cdma.h>
#include <nm-setting-connection.h>
#include <nm-setting-gsm.h>
#include <nm-setting-ip4-config.h>
#include <nm-setting-ip6-config.h>
#include <nm-setting-olpc-mesh.h>
#include <nm-setting-ppp.h>
#include <nm-setting-pppoe.h>
#include <nm-setting-vpn.h>
#include <nm-setting-wimax.h>
#include <nm-setting-wired.h>
#include <nm-setting-wireless.h>
#include <nm-setting-wireless-security.h>
G_BEGIN_DECLS
#define NM_TYPE_CONNECTION (nm_connection_get_type ())
@ -151,6 +167,22 @@ const char * nm_connection_get_uuid (NMConnection *connection);
const char * nm_connection_get_id (NMConnection *connection);
NMSetting8021x * nm_connection_get_setting_802_1x (NMConnection *connection);
NMSettingBluetooth * nm_connection_get_setting_bluetooth (NMConnection *connection);
NMSettingCdma * nm_connection_get_setting_cdma (NMConnection *connection);
NMSettingConnection * nm_connection_get_setting_connection (NMConnection *connection);
NMSettingGsm * nm_connection_get_setting_gsm (NMConnection *connection);
NMSettingIP4Config * nm_connection_get_setting_ip4_config (NMConnection *connection);
NMSettingIP6Config * nm_connection_get_setting_ip6_config (NMConnection *connection);
NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);
NMSettingPPP * nm_connection_get_setting_ppp (NMConnection *connection);
NMSettingPPPOE * nm_connection_get_setting_pppoe (NMConnection *connection);
NMSettingVPN * nm_connection_get_setting_vpn (NMConnection *connection);
NMSettingWimax * nm_connection_get_setting_wimax (NMConnection *connection);
NMSettingWired * nm_connection_get_setting_wired (NMConnection *connection);
NMSettingWireless * nm_connection_get_setting_wireless (NMConnection *connection);
NMSettingWirelessSecurity *nm_connection_get_setting_wireless_security (NMConnection *connection);
G_END_DECLS
#endif /* NM_CONNECTION_H */