libnm-util: add NMSettingGeneric

Add NMSettingGeneric, a dummy L2 NMSetting for creating NMConnections
for devices that are not specifically recognized.
This commit is contained in:
Dan Winship 2013-04-08 11:03:07 -04:00
parent 2226a00cc2
commit 8b823d7c6a
6 changed files with 201 additions and 0 deletions

View file

@ -28,6 +28,7 @@ libnm_util_include_HEADERS = \
nm-setting-ppp.h \
nm-setting-pppoe.h \
nm-setting-serial.h \
nm-setting-generic.h \
nm-setting-gsm.h \
nm-setting-cdma.h \
nm-setting-olpc-mesh.h \
@ -64,6 +65,7 @@ libnm_util_la_csources = \
nm-setting-ppp.c \
nm-setting-pppoe.c \
nm-setting-serial.c \
nm-setting-generic.c \
nm-setting-gsm.c \
nm-setting-cdma.c \
nm-setting-olpc-mesh.c \

View file

@ -23,6 +23,7 @@ global:
nm_connection_get_setting_by_name;
nm_connection_get_setting_cdma;
nm_connection_get_setting_connection;
nm_connection_get_setting_generic;
nm_connection_get_setting_gsm;
nm_connection_get_setting_infiniband;
nm_connection_get_setting_ip4_config;
@ -264,6 +265,9 @@ global:
nm_setting_enumerate_values;
nm_setting_error_get_type;
nm_setting_error_quark;
nm_setting_generic_error_get_type;
nm_setting_generic_error_quark;
nm_setting_generic_get_type;
nm_setting_get_name;
nm_setting_get_secret_flags;
nm_setting_get_type;

View file

@ -1217,6 +1217,22 @@ nm_connection_get_setting_connection (NMConnection *connection)
return (NMSettingConnection *) nm_connection_get_setting (connection, NM_TYPE_SETTING_CONNECTION);
}
/**
* nm_connection_get_setting_generic:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingGeneric the connection might contain.
*
* Returns: (transfer none): an #NMSettingGeneric if the connection contains one, otherwise NULL
**/
NMSettingGeneric *
nm_connection_get_setting_generic (NMConnection *connection)
{
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingGeneric *) nm_connection_get_setting (connection, NM_TYPE_SETTING_GENERIC);
}
/**
* nm_connection_get_setting_gsm:
* @connection: the #NMConnection

View file

@ -37,6 +37,7 @@
#include <nm-setting-bridge-port.h>
#include <nm-setting-cdma.h>
#include <nm-setting-connection.h>
#include <nm-setting-generic.h>
#include <nm-setting-gsm.h>
#include <nm-setting-infiniband.h>
#include <nm-setting-ip4-config.h>
@ -198,6 +199,7 @@ NMSettingBridge * nm_connection_get_setting_bridge (NMConnec
NMSettingBridgePort * nm_connection_get_setting_bridge_port (NMConnection *connection);
NMSettingCdma * nm_connection_get_setting_cdma (NMConnection *connection);
NMSettingConnection * nm_connection_get_setting_connection (NMConnection *connection);
NMSettingGeneric * nm_connection_get_setting_generic (NMConnection *connection);
NMSettingGsm * nm_connection_get_setting_gsm (NMConnection *connection);
NMSettingInfiniband * nm_connection_get_setting_infiniband (NMConnection *connection);
NMSettingIP4Config * nm_connection_get_setting_ip4_config (NMConnection *connection);

View file

@ -0,0 +1,101 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2013 Red Hat, Inc.
*/
#include "config.h"
#include "nm-setting-generic.h"
#include "nm-setting-private.h"
/**
* SECTION:nm-setting-generic
* @short_description: Describes connection properties for generic devices
* @include: nm-setting-generic.h
*
* The #NMSettingGeneric object is a #NMSetting subclass that describes
* optional properties that apply to "generic" devices (ie, devices that
* NetworkManager does not specifically recognize).
*
* There are currently no properties on this object; it exists only to be
* the "connection type" setting on #NMConnections for generic devices.
*
* Since: 0.9.10
**/
/**
* nm_setting_generic_error_quark:
*
* Registers an error quark for #NMSettingGeneric if necessary.
*
* Returns: the error quark used for #NMSettingGeneric errors.
*
* Since: 0.9.10
**/
GQuark
nm_setting_generic_error_quark (void)
{
static GQuark quark;
if (G_UNLIKELY (!quark))
quark = g_quark_from_static_string ("nm-setting-generic-error-quark");
return quark;
}
G_DEFINE_TYPE_WITH_CODE (NMSettingGeneric, nm_setting_generic, NM_TYPE_SETTING,
_nm_register_setting (NM_SETTING_GENERIC_SETTING_NAME,
g_define_type_id,
1,
NM_SETTING_GENERIC_ERROR))
NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_GENERIC)
#define NM_SETTING_GENERIC_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_GENERIC, NMSettingGenericPrivate))
typedef struct {
int dummy;
} NMSettingGenericPrivate;
/**************************************************************************/
/**
* nm_setting_generic_new:
*
* Creates a new #NMSettingGeneric object with default values.
*
* Returns: (transfer full): the new empty #NMSettingGeneric object
*
* Since: 0.9.10
**/
NMSetting *
nm_setting_generic_new (void)
{
return (NMSetting *) g_object_new (NM_TYPE_SETTING_GENERIC, NULL);
}
static void
nm_setting_generic_init (NMSettingGeneric *setting)
{
g_object_set (setting, NM_SETTING_NAME, NM_SETTING_GENERIC_SETTING_NAME, NULL);
}
static void
nm_setting_generic_class_init (NMSettingGenericClass *setting_class)
{
g_type_class_add_private (setting_class, sizeof (NMSettingGenericPrivate));
}

View file

@ -0,0 +1,76 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2013 Red Hat, Inc.
*/
#ifndef NM_SETTING_GENERIC_H
#define NM_SETTING_GENERIC_H
#include <nm-setting.h>
G_BEGIN_DECLS
#define NM_TYPE_SETTING_GENERIC (nm_setting_generic_get_type ())
#define NM_SETTING_GENERIC(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_GENERIC, NMSettingGeneric))
#define NM_SETTING_GENERIC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SETTING_GENERIC, NMSettingGenericClass))
#define NM_IS_SETTING_GENERIC(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SETTING_GENERIC))
#define NM_IS_SETTING_GENERIC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SETTING_GENERIC))
#define NM_SETTING_GENERIC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SETTING_GENERIC, NMSettingGenericClass))
#define NM_SETTING_GENERIC_SETTING_NAME "generic"
/**
* NMSettingGenericError:
* @NM_SETTING_GENERIC_ERROR_UNKNOWN: unknown or unclassified error
* @NM_SETTING_GENERIC_ERROR_INVALID_PROPERTY: the property was invalid
* @NM_SETTING_GENERIC_ERROR_MISSING_PROPERTY: the property was missing and
* is required
*
* Since: 0.9.10
*/
typedef enum {
NM_SETTING_GENERIC_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/
NM_SETTING_GENERIC_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
NM_SETTING_GENERIC_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
} NMSettingGenericError;
#define NM_SETTING_GENERIC_ERROR nm_setting_generic_error_quark ()
GQuark nm_setting_generic_error_quark (void);
typedef struct {
NMSetting parent;
} NMSettingGeneric;
typedef struct {
NMSettingClass parent;
/* Padding for future expansion */
void (*_reserved1) (void);
void (*_reserved2) (void);
void (*_reserved3) (void);
void (*_reserved4) (void);
} NMSettingGenericClass;
GType nm_setting_generic_get_type (void);
NMSetting * nm_setting_generic_new (void);
G_END_DECLS
#endif /* NM_SETTING_GENERIC_H */