summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2015-06-02 11:02:49 +0200
committerThomas Haller <thaller@redhat.com>2015-07-17 13:56:17 +0200
commitd1e780d3437c8b579845ce4e014d09ce4bbd5989 (patch)
tree31a7af30e418d84a70af5b01e6edd0e75dc159b8
parent3228fbdf493c53157a38add020832476ce2c741a (diff)
downloadNetworkManager-th/libnm-vpn-plugin-bgo749877-2.tar.gz
libnm/vpn: add annotations for new NMVpnServicePlugin APIth/libnm-vpn-plugin-bgo749877-2
-rw-r--r--libnm/nm-vpn-service-plugin.c12
-rw-r--r--libnm/nm-vpn-service-plugin.h32
2 files changed, 42 insertions, 2 deletions
diff --git a/libnm/nm-vpn-service-plugin.c b/libnm/nm-vpn-service-plugin.c
index ab1c92f87f..6c66e61b0f 100644
--- a/libnm/nm-vpn-service-plugin.c
+++ b/libnm/nm-vpn-service-plugin.c
@@ -114,6 +114,8 @@ nm_vpn_service_plugin_set_connection (NMVpnServicePlugin *plugin,
* nm_vpn_service_plugin_get_connection:
*
* Returns: (transfer full):
+ *
+ * Since: 1.2
*/
GDBusConnection *
nm_vpn_service_plugin_get_connection (NMVpnServicePlugin *plugin)
@@ -596,6 +598,8 @@ impl_vpn_service_plugin_new_secrets (NMVpnServicePlugin *plugin,
* request new secrets when the secrets originally provided by NetworkManager
* are insufficient, or the VPN process indicates that it needs additional
* information to complete the request.
+ *
+ * Since: 1.2
*/
void
nm_vpn_service_plugin_secrets_required (NMVpnServicePlugin *plugin,
@@ -649,6 +653,8 @@ free_secret (gpointer data)
* an applet when the applet calls the authentication dialog of the VPN plugin.
*
* Returns: %TRUE if reading values was successful, %FALSE if not
+ *
+ * Since: 1.2
**/
gboolean
nm_vpn_service_plugin_read_vpn_details (int fd,
@@ -750,6 +756,8 @@ nm_vpn_service_plugin_read_vpn_details (int fd,
*
* Returns: %TRUE if the flag data item was found and successfully converted
* to flags, %FALSE if not
+ *
+ * Since: 1.2
**/
gboolean
nm_vpn_service_plugin_get_secret_flags (GHashTable *data,
@@ -1103,6 +1111,8 @@ nm_vpn_service_plugin_class_init (NMVpnServicePluginClass *plugin_class)
* NMVpnServicePlugin:service-name:
*
* The D-Bus service name of this plugin.
+ *
+ * Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_DBUS_SERVICE_NAME,
@@ -1116,6 +1126,8 @@ nm_vpn_service_plugin_class_init (NMVpnServicePluginClass *plugin_class)
* NMVpnServicePlugin:state:
*
* The state of the plugin.
+ *
+ * Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_STATE,
diff --git a/libnm/nm-vpn-service-plugin.h b/libnm/nm-vpn-service-plugin.h
index fca6f7ebfa..81ba40457f 100644
--- a/libnm/nm-vpn-service-plugin.h
+++ b/libnm/nm-vpn-service-plugin.h
@@ -39,94 +39,122 @@ G_BEGIN_DECLS
#define NM_VPN_SERVICE_PLUGIN_STATE "state"
typedef struct {
+ NM_AVAILABLE_IN_1_2
GObject parent;
-} NMVpnServicePlugin;
+} NMVpnServicePlugin NM_AVAILABLE_IN_1_2;
typedef struct {
+ NM_AVAILABLE_IN_1_2
GObjectClass parent;
/* Signals */
+ NM_AVAILABLE_IN_1_2
void (*state_changed) (NMVpnServicePlugin *plugin,
NMVpnServiceState state);
+ NM_AVAILABLE_IN_1_2
void (*ip4_config) (NMVpnServicePlugin *plugin,
GVariant *ip4_config);
+ NM_AVAILABLE_IN_1_2
void (*login_banner) (NMVpnServicePlugin *plugin,
const char *banner);
+ NM_AVAILABLE_IN_1_2
void (*failure) (NMVpnServicePlugin *plugin,
NMVpnPluginFailure reason);
+ NM_AVAILABLE_IN_1_2
void (*quit) (NMVpnServicePlugin *plugin);
+ NM_AVAILABLE_IN_1_2
void (*config) (NMVpnServicePlugin *plugin,
GVariant *config);
+ NM_AVAILABLE_IN_1_2
void (*ip6_config) (NMVpnServicePlugin *plugin,
GVariant *config);
/* virtual methods */
+ NM_AVAILABLE_IN_1_2
gboolean (*connect) (NMVpnServicePlugin *plugin,
NMConnection *connection,
GError **err);
+ NM_AVAILABLE_IN_1_2
gboolean (*need_secrets) (NMVpnServicePlugin *plugin,
NMConnection *connection,
const char **setting_name,
GError **error);
+ NM_AVAILABLE_IN_1_2
gboolean (*disconnect) (NMVpnServicePlugin *plugin,
GError **err);
+ NM_AVAILABLE_IN_1_2
gboolean (*new_secrets) (NMVpnServicePlugin *plugin,
NMConnection *connection,
GError **error);
+ NM_AVAILABLE_IN_1_2
gboolean (*connect_interactive) (NMVpnServicePlugin *plugin,
NMConnection *connection,
GVariant *details,
GError **error);
/*< private >*/
+ NM_AVAILABLE_IN_1_2
gpointer padding[8];
-} NMVpnServicePluginClass;
+} NMVpnServicePluginClass NM_AVAILABLE_IN_1_2;
+NM_AVAILABLE_IN_1_2
GType nm_vpn_service_plugin_get_type (void);
+NM_AVAILABLE_IN_1_2
GDBusConnection *nm_vpn_service_plugin_get_connection (NMVpnServicePlugin *plugin);
+NM_AVAILABLE_IN_1_2
NMVpnServiceState nm_vpn_service_plugin_get_state (NMVpnServicePlugin *plugin);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_set_state (NMVpnServicePlugin *plugin,
NMVpnServiceState state);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_secrets_required (NMVpnServicePlugin *plugin,
const char *message,
const char **hints);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_set_login_banner (NMVpnServicePlugin *plugin,
const char *banner);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_failure (NMVpnServicePlugin *plugin,
NMVpnPluginFailure reason);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_set_config (NMVpnServicePlugin *plugin,
GVariant *config);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_set_ip4_config (NMVpnServicePlugin *plugin,
GVariant *ip4_config);
+NM_AVAILABLE_IN_1_2
void nm_vpn_service_plugin_set_ip6_config (NMVpnServicePlugin *plugin,
GVariant *ip6_config);
+NM_AVAILABLE_IN_1_2
gboolean nm_vpn_service_plugin_disconnect (NMVpnServicePlugin *plugin,
GError **err);
/* Utility functions */
+NM_AVAILABLE_IN_1_2
gboolean nm_vpn_service_plugin_read_vpn_details (int fd,
GHashTable **out_data,
GHashTable **out_secrets);
+NM_AVAILABLE_IN_1_2
gboolean nm_vpn_service_plugin_get_secret_flags (GHashTable *data,
const char *secret_name,
NMSettingSecretFlags *out_flags);