mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2025-12-25 13:00:16 +01:00
fbb038af5e
Add a "a{sv}" output argument to "AddAndActivate2" D-Bus API.
"AddAndActivate2" replaces "AddAndActivate" with more options.
It also has a dictionary argument to be forward compatible so that we
hopefully won't need an "AddAndActivate3". However, it lacked a similar
output dictionary. Add it for future extensibility. I think this is
really to workaround a shortcoming of D-Bus, which does provide strong
typing and type information about its API, but does not allow to extend
an existing API in a backward compatible manner. So we either resort to
Method(), Method2(), Method3() variants, or a catch-all variant with a
generic "a{sv}" input/output argument.
In libnm, rename "nm_client_add_and_activate_connection_options()" to
"nm_client_add_and_activate_connection2()". I think libnm API should have
an obvious correspondence with D-Bus API. Or stated differently, if
"AddAndActivateOptions" would be a better name, then the D-Bus API should
be renamed. We should prefer one name over the other, but regardless
of which is preferred, the naming for D-Bus and libnm API should
correspond.
In this case, I do think that AddAndActivate2() is a better name than
AddAndActivateOptions(). Hence I rename the libnm API.
Also, unless necessary, let libnm still call "AddAndActivate" instead of
"AddAndActivate2". Our backward compatibility works the way that libnm
requires a server version at least as new as itself. As such, libnm
theoretically could assume that server version is new enough to support
"AddAndActivate2" and could always use the more powerful variant.
However, we don't need to break compatibility intentionally and for
little gain. Here, it's easy to let libnm also handle old server API, by
continuing to use "AddAndActivate" for nm_client_add_and_activate_connection().
Note that during package update, we don't restart the currently running
NetworkManager instance. In such a scenario, it can easily happen that
nmcli/libnm is newer than the server version. Let's try a bit harder
to not break that.
Changes as discussed in [1].
[1] https://gitlab.freedesktop.org/NetworkManager/NetworkManager/merge_requests/37#note_79876
240 lines
12 KiB
C
240 lines
12 KiB
C
/* -*- 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 2007 - 2008 Novell, Inc.
|
|
* Copyright 2007 - 2014 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef __NM_MANAGER_H__
|
|
#define __NM_MANAGER_H__
|
|
|
|
#if !((NETWORKMANAGER_COMPILATION) & NM_NETWORKMANAGER_COMPILATION_WITH_LIBNM_PRIVATE)
|
|
#error Cannot use this header.
|
|
#endif
|
|
|
|
#include "nm-object.h"
|
|
#include "nm-client.h"
|
|
|
|
#define NM_TYPE_MANAGER (nm_manager_get_type ())
|
|
#define NM_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_MANAGER, NMManager))
|
|
#define NM_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_MANAGER, NMManagerClass))
|
|
#define NM_IS_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_MANAGER))
|
|
#define NM_IS_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_MANAGER))
|
|
#define NM_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_MANAGER, NMManagerClass))
|
|
|
|
#define NM_MANAGER_VERSION "version"
|
|
#define NM_MANAGER_STATE "state"
|
|
#define NM_MANAGER_STARTUP "startup"
|
|
#define NM_MANAGER_NETWORKING_ENABLED "networking-enabled"
|
|
#define NM_MANAGER_WIRELESS_ENABLED "wireless-enabled"
|
|
#define NM_MANAGER_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
|
|
#define NM_MANAGER_WWAN_ENABLED "wwan-enabled"
|
|
#define NM_MANAGER_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
|
|
#define NM_MANAGER_WIMAX_ENABLED "wimax-enabled"
|
|
#define NM_MANAGER_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
|
|
#define NM_MANAGER_ACTIVE_CONNECTIONS "active-connections"
|
|
#define NM_MANAGER_CONNECTIVITY "connectivity"
|
|
#define NM_MANAGER_CONNECTIVITY_CHECK_AVAILABLE "connectivity-check-available"
|
|
#define NM_MANAGER_CONNECTIVITY_CHECK_ENABLED "connectivity-check-enabled"
|
|
#define NM_MANAGER_PRIMARY_CONNECTION "primary-connection"
|
|
#define NM_MANAGER_ACTIVATING_CONNECTION "activating-connection"
|
|
#define NM_MANAGER_DEVICES "devices"
|
|
#define NM_MANAGER_CHECKPOINTS "checkpoints"
|
|
#define NM_MANAGER_METERED "metered"
|
|
#define NM_MANAGER_ALL_DEVICES "all-devices"
|
|
|
|
/**
|
|
* NMManager:
|
|
*/
|
|
typedef struct {
|
|
NMObject parent;
|
|
} NMManager;
|
|
|
|
typedef struct {
|
|
NMObjectClass parent;
|
|
|
|
/* Signals */
|
|
void (*device_added) (NMManager *manager, NMDevice *device);
|
|
void (*device_removed) (NMManager *manager, NMDevice *device);
|
|
void (*active_connection_added) (NMManager *manager, NMActiveConnection *ac);
|
|
void (*active_connection_removed) (NMManager *manager, NMActiveConnection *ac);
|
|
void (*checkpoint_added) (NMManager *manager, NMCheckpoint *checkpoint);
|
|
void (*checkpoint_removed) (NMManager *manager, NMCheckpoint *checkpoint);
|
|
void (*permission_changed) (NMManager *manager,
|
|
NMClientPermission permission,
|
|
NMClientPermissionResult result);
|
|
} NMManagerClass;
|
|
|
|
GType nm_manager_get_type (void);
|
|
|
|
const char *nm_manager_get_version (NMManager *manager);
|
|
NMState nm_manager_get_state (NMManager *manager);
|
|
gboolean nm_manager_get_startup (NMManager *manager);
|
|
|
|
gboolean nm_manager_networking_get_enabled (NMManager *manager);
|
|
gboolean nm_manager_networking_set_enabled (NMManager *manager,
|
|
gboolean enabled,
|
|
GError **error);
|
|
|
|
gboolean nm_manager_wireless_get_enabled (NMManager *manager);
|
|
void nm_manager_wireless_set_enabled (NMManager *manager, gboolean enabled);
|
|
gboolean nm_manager_wireless_hardware_get_enabled (NMManager *manager);
|
|
|
|
gboolean nm_manager_wwan_get_enabled (NMManager *manager);
|
|
void nm_manager_wwan_set_enabled (NMManager *manager, gboolean enabled);
|
|
gboolean nm_manager_wwan_hardware_get_enabled (NMManager *manager);
|
|
|
|
gboolean nm_manager_wimax_get_enabled (NMManager *manager);
|
|
void nm_manager_wimax_set_enabled (NMManager *manager, gboolean enabled);
|
|
gboolean nm_manager_wimax_hardware_get_enabled (NMManager *manager);
|
|
|
|
gboolean nm_manager_connectivity_check_get_available (NMManager *manager);
|
|
|
|
gboolean nm_manager_connectivity_check_get_enabled (NMManager *manager);
|
|
|
|
void nm_manager_connectivity_check_set_enabled (NMManager *manager,
|
|
gboolean enabled);
|
|
|
|
gboolean nm_manager_get_logging (NMManager *manager,
|
|
char **level,
|
|
char **domains,
|
|
GError **error);
|
|
gboolean nm_manager_set_logging (NMManager *manager,
|
|
const char *level,
|
|
const char *domains,
|
|
GError **error);
|
|
|
|
NMClientPermissionResult nm_manager_get_permission_result (NMManager *manager,
|
|
NMClientPermission permission);
|
|
|
|
NMConnectivityState nm_manager_get_connectivity (NMManager *manager);
|
|
|
|
NMConnectivityState nm_manager_check_connectivity (NMManager *manager,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void nm_manager_check_connectivity_async (NMManager *manager,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
NMConnectivityState nm_manager_check_connectivity_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
/* Devices */
|
|
|
|
const GPtrArray *nm_manager_get_devices (NMManager *manager);
|
|
const GPtrArray *nm_manager_get_all_devices(NMManager *manager);
|
|
NMDevice *nm_manager_get_device_by_path (NMManager *manager, const char *object_path);
|
|
NMDevice *nm_manager_get_device_by_iface (NMManager *manager, const char *iface);
|
|
|
|
/* Active Connections */
|
|
|
|
const GPtrArray *nm_manager_get_active_connections (NMManager *manager);
|
|
|
|
NMActiveConnection *nm_manager_get_primary_connection (NMManager *manager);
|
|
NMActiveConnection *nm_manager_get_activating_connection (NMManager *manager);
|
|
|
|
void nm_manager_activate_connection_async (NMManager *manager,
|
|
NMConnection *connection,
|
|
NMDevice *device,
|
|
const char *specific_object,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
NMActiveConnection *nm_manager_activate_connection_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
void nm_manager_add_and_activate_connection_async (NMManager *manager,
|
|
NMConnection *partial,
|
|
NMDevice *device,
|
|
const char *specific_object,
|
|
GVariant *options,
|
|
gboolean force_v2,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
NMActiveConnection *nm_manager_add_and_activate_connection_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GVariant **out_result,
|
|
GError **error);
|
|
|
|
gboolean nm_manager_deactivate_connection (NMManager *manager,
|
|
NMActiveConnection *active,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void nm_manager_deactivate_connection_async (NMManager *manager,
|
|
NMActiveConnection *active,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean nm_manager_deactivate_connection_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
const GPtrArray *nm_manager_get_checkpoints (NMManager *manager);
|
|
void nm_manager_checkpoint_create (NMManager *manager,
|
|
const GPtrArray *devices,
|
|
guint32 rollback_timeout,
|
|
NMCheckpointCreateFlags flags,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
NMCheckpoint *nm_manager_checkpoint_create_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void nm_manager_checkpoint_destroy (NMManager *manager,
|
|
const char *checkpoint_path,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean nm_manager_checkpoint_destroy_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void nm_manager_checkpoint_rollback (NMManager *manager,
|
|
const char *checkpoint_path,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GHashTable *nm_manager_checkpoint_rollback_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void nm_manager_checkpoint_adjust_rollback_timeout (NMManager *manager,
|
|
const char *checkpoint_path,
|
|
guint32 add_timeout,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean nm_manager_checkpoint_adjust_rollback_timeout_finish (NMManager *manager,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
/*****************************************************************************/
|
|
|
|
typedef struct {
|
|
NMActiveConnection *active;
|
|
GVariant *add_and_activate_output;
|
|
} _NMActivateResult;
|
|
|
|
_NMActivateResult *_nm_activate_result_new (NMActiveConnection *active,
|
|
GVariant *add_and_activate_output);
|
|
|
|
void _nm_activate_result_free (_NMActivateResult *result);
|
|
|
|
/*****************************************************************************/
|
|
|
|
#endif /* __NM_MANAGER_H__ */
|