1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2007 - 2013 Red Hat, Inc.
4 * Copyright (C) 2007 - 2008 Novell, Inc.
5 */
6
7#ifndef __NM_SETTING_VPN_H__
8#define __NM_SETTING_VPN_H__
9
10#if !defined(__NETWORKMANAGER_H_INSIDE__) && !defined(NETWORKMANAGER_COMPILATION)
11#error "Only <NetworkManager.h> can be included directly."
12#endif
13
14#include "nm-setting.h"
15
16G_BEGIN_DECLS
17
18#define NM_TYPE_SETTING_VPN (nm_setting_vpn_get_type())
19#define NM_SETTING_VPN(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), NM_TYPE_SETTING_VPN, NMSettingVpn))
20#define NM_SETTING_VPN_CLASS(klass) \
21 (G_TYPE_CHECK_CLASS_CAST((klass), NM_TYPE_SETTING_VPN, NMSettingVpnClass))
22#define NM_IS_SETTING_VPN(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), NM_TYPE_SETTING_VPN))
23#define NM_IS_SETTING_VPN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), NM_TYPE_SETTING_VPN))
24#define NM_SETTING_VPN_GET_CLASS(obj) \
25 (G_TYPE_INSTANCE_GET_CLASS((obj), NM_TYPE_SETTING_VPN, NMSettingVpnClass))
26
27#define NM_SETTING_VPN_SETTING_NAME "vpn"
28
29#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
30#define NM_SETTING_VPN_USER_NAME "user-name"
31#define NM_SETTING_VPN_PERSISTENT "persistent"
32#define NM_SETTING_VPN_DATA "data"
33#define NM_SETTING_VPN_SECRETS "secrets"
34#define NM_SETTING_VPN_TIMEOUT "timeout"
35
36typedef struct _NMSettingVpnClass NMSettingVpnClass;
37
38/**
39 * NMVpnIterFunc:
40 * @key: the name of the data or secret item
41 * @value: the value of the data or secret item
42 * @user_data: User data passed to nm_setting_vpn_foreach_data_item() or
43 * nm_setting_vpn_foreach_secret()
44 **/
45typedef void (*NMVpnIterFunc)(const char *key, const char *value, gpointer user_data);
46
47GType nm_setting_vpn_get_type(void);
48
49NMSetting *nm_setting_vpn_new(void);
50const char *nm_setting_vpn_get_service_type(NMSettingVpn *setting);
51const char *nm_setting_vpn_get_user_name(NMSettingVpn *setting);
52gboolean nm_setting_vpn_get_persistent(NMSettingVpn *setting);
53
54guint32 nm_setting_vpn_get_num_data_items(NMSettingVpn *setting);
55void nm_setting_vpn_add_data_item(NMSettingVpn *setting, const char *key, const char *item);
56const char *nm_setting_vpn_get_data_item(NMSettingVpn *setting, const char *key);
57gboolean nm_setting_vpn_remove_data_item(NMSettingVpn *setting, const char *key);
58void
59nm_setting_vpn_foreach_data_item(NMSettingVpn *setting, NMVpnIterFunc func, gpointer user_data);
60NM_AVAILABLE_IN_1_12
61const char **nm_setting_vpn_get_data_keys(NMSettingVpn *setting, guint *out_length);
62
63guint32 nm_setting_vpn_get_num_secrets(NMSettingVpn *setting);
64void nm_setting_vpn_add_secret(NMSettingVpn *setting, const char *key, const char *secret);
65const char *nm_setting_vpn_get_secret(NMSettingVpn *setting, const char *key);
66gboolean nm_setting_vpn_remove_secret(NMSettingVpn *setting, const char *key);
67void nm_setting_vpn_foreach_secret(NMSettingVpn *setting, NMVpnIterFunc func, gpointer user_data);
68NM_AVAILABLE_IN_1_12
69const char **nm_setting_vpn_get_secret_keys(NMSettingVpn *setting, guint *out_length);
70
71NM_AVAILABLE_IN_1_2
72guint32 nm_setting_vpn_get_timeout(NMSettingVpn *setting);
73
74G_END_DECLS
75
76#endif /* __NM_SETTING_VPN_H__ */
77

source code of include/libnm/nm-setting-vpn.h