nm-setting-vpn.h 4.87 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */

/*
 * Dan Williams <dcbw@redhat.com>
 * Tambet Ingo <tambet@gmail.com>
 *
 * 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.
 *
22
 * (C) Copyright 2007 - 2013 Red Hat, Inc.
23 24
 * (C) Copyright 2007 - 2008 Novell, Inc.
 */
25 26 27 28 29 30 31 32 33 34 35 36

#ifndef NM_SETTING_VPN_H
#define NM_SETTING_VPN_H

#include <nm-setting.h>

G_BEGIN_DECLS

#define NM_TYPE_SETTING_VPN            (nm_setting_vpn_get_type ())
#define NM_SETTING_VPN(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_VPN, NMSettingVPN))
#define NM_SETTING_VPN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SETTING_VPN, NMSettingVPNClass))
#define NM_IS_SETTING_VPN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SETTING_VPN))
37
#define NM_IS_SETTING_VPN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SETTING_VPN))
38 39 40 41
#define NM_SETTING_VPN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SETTING_VPN, NMSettingVPNClass))

#define NM_SETTING_VPN_SETTING_NAME "vpn"

Dan Williams's avatar
Dan Williams committed
42
/**
Dan Williams's avatar
Dan Williams committed
43
 * NMSettingVpnError:
Dan Williams's avatar
Dan Williams committed
44 45 46 47 48 49
 * @NM_SETTING_VPN_ERROR_UNKNOWN: unknown or unclassified error
 * @NM_SETTING_VPN_ERROR_INVALID_PROPERTY: the property was invalid
 * @NM_SETTING_VPN_ERROR_MISSING_PROPERTY: the property was missing and is
 * required
 */
typedef enum {
Dan Winship's avatar
Dan Winship committed
50 51 52
	NM_SETTING_VPN_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
	NM_SETTING_VPN_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
	NM_SETTING_VPN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
53 54 55 56 57
} NMSettingVpnError;

#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
GQuark nm_setting_vpn_error_quark (void);

58 59
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
#define NM_SETTING_VPN_USER_NAME    "user-name"
60
#define NM_SETTING_VPN_DATA         "data"
61
#define NM_SETTING_VPN_SECRETS      "secrets"
62 63 64 65 66 67 68

typedef struct {
	NMSetting parent;
} NMSettingVPN;

typedef struct {
	NMSettingClass parent;
69 70 71 72 73 74

	/* Padding for future expansion */
	void (*_reserved1) (void);
	void (*_reserved2) (void);
	void (*_reserved3) (void);
	void (*_reserved4) (void);
75 76
} NMSettingVPNClass;

Dan Williams's avatar
Dan Williams committed
77 78 79 80 81 82 83
/**
 * NMVPNIterFunc:
 * @key: the name of the data or secret item
 * @value: the value of the data or secret item
 * @user_data: User data passed to nm_setting_vpn_foreach_data_item() or
 * nm_setting_vpn_foreach_secret()
 **/
84
typedef void (*NMVPNIterFunc) (const char *key, const char *value, gpointer user_data);
85

86 87
GType nm_setting_vpn_get_type (void);

88 89 90 91
NMSetting        *nm_setting_vpn_new               (void);
const char       *nm_setting_vpn_get_service_type  (NMSettingVPN *setting);
const char       *nm_setting_vpn_get_user_name     (NMSettingVPN *setting);

92
guint32           nm_setting_vpn_get_num_data_items (NMSettingVPN *setting);
93 94 95 96 97
void              nm_setting_vpn_add_data_item     (NMSettingVPN *setting,
                                                    const char *key,
                                                    const char *item);
const char *      nm_setting_vpn_get_data_item     (NMSettingVPN *setting,
                                                    const char *key);
98
gboolean          nm_setting_vpn_remove_data_item  (NMSettingVPN *setting,
99 100
                                                    const char *key);
void              nm_setting_vpn_foreach_data_item (NMSettingVPN *setting,
101
                                                    NMVPNIterFunc func,
102 103
                                                    gpointer user_data);

104
guint32           nm_setting_vpn_get_num_secrets   (NMSettingVPN *setting);
105 106 107 108 109
void              nm_setting_vpn_add_secret        (NMSettingVPN *setting,
                                                    const char *key,
                                                    const char *secret);
const char *      nm_setting_vpn_get_secret        (NMSettingVPN *setting,
                                                    const char *key);
110
gboolean          nm_setting_vpn_remove_secret     (NMSettingVPN *setting,
111 112
                                                    const char *key);
void              nm_setting_vpn_foreach_secret    (NMSettingVPN *setting,
113
                                                    NMVPNIterFunc func,
114
                                                    gpointer user_data);
115 116 117 118

G_END_DECLS

#endif /* NM_SETTING_VPN_H */