summaryrefslogtreecommitdiff
path: root/libnm-core/nm-setting-proxy.h
diff options
context:
space:
mode:
authorAtul Anand <atulhjp@gmail.com>2016-08-16 05:55:55 +0530
committerThomas Haller <thaller@redhat.com>2016-10-04 11:44:13 +0200
commit2a40112ebe9e153f7431e817a0c5f6229e642215 (patch)
tree587062cf5b3485feb10e54f9a968b3616a44b930 /libnm-core/nm-setting-proxy.h
parenta5a36d6dfe0b3b4c69d25fae8c70ee07093d3f7b (diff)
downloadNetworkManager-2a40112ebe9e153f7431e817a0c5f6229e642215.tar.gz
libnm: API for Proxy Feature
libnm-core has been expanded to include proxy settings which clients like nmcli, nm-connection-editor use to configure proxy in PacRunner. It offers three modes i.e 'auto', 'manual'and 'none' and accordingly take data to configure PacRunner. The modes matches on the PacRunner side too.
Diffstat (limited to 'libnm-core/nm-setting-proxy.h')
-rw-r--r--libnm-core/nm-setting-proxy.h123
1 files changed, 123 insertions, 0 deletions
diff --git a/libnm-core/nm-setting-proxy.h b/libnm-core/nm-setting-proxy.h
new file mode 100644
index 0000000000..81c4906ac9
--- /dev/null
+++ b/libnm-core/nm-setting-proxy.h
@@ -0,0 +1,123 @@
+/* -*- 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.
+ *
+ * (C) Copyright 2016 Atul Anand <atulhjp@gmail.com>.
+ */
+
+#ifndef __NM_SETTING_PROXY_H__
+#define __NM_SETTING_PROXY_H__
+
+#if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
+#error "Only <NetworkManager.h> can be included directly."
+#endif
+
+#include <nm-setting.h>
+
+G_BEGIN_DECLS
+
+/**
+ * NMSettingProxyMethod:
+ * @NM_SETTING_PROXY_METHOD_AUTO: DHCP obtained Proxy
+ * @NM_SETTING_PROXY_METHOD_MANUAL: Manual mode
+ * @NM_SETTING_PROXY_METHOD_NONE: No Proxy for the Connection
+ *
+ * The Proxy method.
+ *
+ * Since: 1.6
+ */
+typedef enum {
+ NM_SETTING_PROXY_METHOD_AUTO = 0,
+ NM_SETTING_PROXY_METHOD_MANUAL,
+ NM_SETTING_PROXY_METHOD_NONE
+} NMSettingProxyMethod;
+
+#define NM_TYPE_SETTING_PROXY (nm_setting_proxy_get_type ())
+#define NM_SETTING_PROXY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_PROXY, NMSettingProxy))
+#define NM_SETTING_PROXY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SETTING_PROXY, NMSettingProxyClass))
+#define NM_IS_SETTING_PROXY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SETTING_PROXY))
+#define NM_IS_SETTING_PROXY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SETTING_PROXY))
+#define NM_SETTING_PROXY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SETTING_PROXY, NMSettingProxyClass))
+
+#define NM_SETTING_PROXY_SETTING_NAME "proxy"
+
+#define NM_SETTING_PROXY_METHOD "method"
+#define NM_SETTING_PROXY_HTTP_PROXY "http-proxy"
+#define NM_SETTING_PROXY_HTTP_PORT "http-port"
+#define NM_SETTING_PROXY_HTTP_DEFAULT "http-default"
+#define NM_SETTING_PROXY_SSL_PROXY "ssl-proxy"
+#define NM_SETTING_PROXY_SSL_PORT "ssl-port"
+#define NM_SETTING_PROXY_FTP_PROXY "ftp-proxy"
+#define NM_SETTING_PROXY_FTP_PORT "ftp-port"
+#define NM_SETTING_PROXY_SOCKS_PROXY "socks-proxy"
+#define NM_SETTING_PROXY_SOCKS_PORT "socks-port"
+#define NM_SETTING_PROXY_SOCKS_VERSION_5 "socks-version-5"
+#define NM_SETTING_PROXY_NO_PROXY_FOR "no-proxy-for"
+#define NM_SETTING_PROXY_BROWSER_ONLY "browser-only"
+#define NM_SETTING_PROXY_PAC_URL "pac-url"
+#define NM_SETTING_PROXY_PAC_SCRIPT "pac-script"
+
+struct _NMSettingProxy {
+ NMSetting parent;
+};
+
+typedef struct {
+ NMSettingClass parent;
+
+ gpointer padding[4];
+} NMSettingProxyClass;
+
+NM_AVAILABLE_IN_1_6
+GType nm_setting_proxy_get_type (void);
+
+NM_AVAILABLE_IN_1_6
+NMSetting *nm_setting_proxy_new (void);
+
+NM_AVAILABLE_IN_1_6
+NMSettingProxyMethod nm_setting_proxy_get_method (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *nm_setting_proxy_get_http_proxy (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+guint32 nm_setting_proxy_get_http_port (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+gboolean nm_setting_proxy_get_http_default (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *nm_setting_proxy_get_ssl_proxy (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+guint32 nm_setting_proxy_get_ssl_port (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *nm_setting_proxy_get_ftp_proxy (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+guint32 nm_setting_proxy_get_ftp_port (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *nm_setting_proxy_get_socks_proxy (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+guint32 nm_setting_proxy_get_socks_port (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+gboolean nm_setting_proxy_get_socks_version_5 (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *const*nm_setting_proxy_get_no_proxy_for (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+gboolean nm_setting_proxy_get_browser_only (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *nm_setting_proxy_get_pac_url (NMSettingProxy *setting);
+NM_AVAILABLE_IN_1_6
+const char *nm_setting_proxy_get_pac_script (NMSettingProxy *setting);
+
+G_END_DECLS
+
+#endif /* __NM_SETTING_PROXY_H__ */