mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-07 00:31:11 +00:00
831286df30
In practice, this should only matter when there are multiple header files with the same name. That is something we try to avoid already, by giving headers a distinct name. When building NetworkManager itself, we clearly want to use double-quotes for including our own headers. But we also want to do that in our public headers. For example: ./a.c #include <stdio.h> #include <nm-1.h> void main() { printf ("INCLUDED %s/nm-2.h\n", SYMB); } ./1/nm-1.h #include <nm-2.h> ./1/nm-2.h #define SYMB "1" ./2/nm-2.h #define SYMB "2" $ cc -I./2 -I./1 ./a.c $ ./a.out INCLUDED 2/nm-2.h Exceptions to this are - headers in "shared/nm-utils" that include <NetworkManager.h>. These headers are copied into projects and hence used like headers owned by those projects. - examples/C
237 lines
11 KiB
C
237 lines
11 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 - 2013 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef __NM_DEVICE_H__
|
|
#define __NM_DEVICE_H__
|
|
|
|
#if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
|
|
#error "Only <NetworkManager.h> can be included directly."
|
|
#endif
|
|
|
|
#include "nm-object.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define NM_TYPE_DEVICE (nm_device_get_type ())
|
|
#define NM_DEVICE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_DEVICE, NMDevice))
|
|
#define NM_DEVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_DEVICE, NMDeviceClass))
|
|
#define NM_IS_DEVICE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DEVICE))
|
|
#define NM_IS_DEVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DEVICE))
|
|
#define NM_DEVICE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_DEVICE, NMDeviceClass))
|
|
|
|
#define NM_DEVICE_DEVICE_TYPE "device-type"
|
|
#define NM_DEVICE_UDI "udi"
|
|
#define NM_DEVICE_INTERFACE "interface"
|
|
#define NM_DEVICE_IP_INTERFACE "ip-interface"
|
|
#define NM_DEVICE_DRIVER "driver"
|
|
#define NM_DEVICE_DRIVER_VERSION "driver-version"
|
|
#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
|
|
#define NM_DEVICE_CAPABILITIES "capabilities"
|
|
#define NM_DEVICE_REAL "real"
|
|
#define NM_DEVICE_MANAGED "managed"
|
|
#define NM_DEVICE_AUTOCONNECT "autoconnect"
|
|
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
|
|
#define NM_DEVICE_NM_PLUGIN_MISSING "nm-plugin-missing"
|
|
#define NM_DEVICE_IP4_CONFIG "ip4-config"
|
|
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
|
|
#define NM_DEVICE_IP6_CONFIG "ip6-config"
|
|
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
|
|
#define NM_DEVICE_STATE "state"
|
|
#define NM_DEVICE_STATE_REASON "state-reason"
|
|
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
|
|
#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
|
|
#define NM_DEVICE_VENDOR "vendor"
|
|
#define NM_DEVICE_PRODUCT "product"
|
|
#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id"
|
|
#define NM_DEVICE_MTU "mtu"
|
|
#define NM_DEVICE_METERED "metered"
|
|
#define NM_DEVICE_LLDP_NEIGHBORS "lldp-neighbors"
|
|
|
|
/**
|
|
* NMDevice:
|
|
*/
|
|
struct _NMDevice {
|
|
NMObject parent;
|
|
};
|
|
|
|
typedef struct {
|
|
NMObjectClass parent;
|
|
|
|
/* Signals */
|
|
void (*state_changed) (NMDevice *device,
|
|
NMDeviceState new_state,
|
|
NMDeviceState old_state,
|
|
NMDeviceStateReason reason);
|
|
|
|
/* Methods */
|
|
gboolean (*connection_compatible) (NMDevice *device,
|
|
NMConnection *connection,
|
|
GError **error);
|
|
|
|
const char * (*get_type_description) (NMDevice *device);
|
|
const char * (*get_hw_address) (NMDevice *device);
|
|
|
|
GType (*get_setting_type) (NMDevice *device);
|
|
|
|
/*< private >*/
|
|
gpointer padding[8];
|
|
} NMDeviceClass;
|
|
|
|
typedef struct _NMLldpNeighbor NMLldpNeighbor;
|
|
|
|
GType nm_device_get_type (void);
|
|
|
|
const char * nm_device_get_iface (NMDevice *device);
|
|
const char * nm_device_get_ip_iface (NMDevice *device);
|
|
NMDeviceType nm_device_get_device_type (NMDevice *device);
|
|
const char * nm_device_get_udi (NMDevice *device);
|
|
const char * nm_device_get_driver (NMDevice *device);
|
|
const char * nm_device_get_driver_version (NMDevice *device);
|
|
const char * nm_device_get_firmware_version (NMDevice *device);
|
|
const char * nm_device_get_type_description (NMDevice *device);
|
|
const char * nm_device_get_hw_address (NMDevice *device);
|
|
NMDeviceCapabilities nm_device_get_capabilities (NMDevice *device);
|
|
gboolean nm_device_get_managed (NMDevice *device);
|
|
NM_AVAILABLE_IN_1_2
|
|
void nm_device_set_managed (NMDevice *device, gboolean managed);
|
|
gboolean nm_device_get_autoconnect (NMDevice *device);
|
|
void nm_device_set_autoconnect (NMDevice *device, gboolean autoconnect);
|
|
gboolean nm_device_get_firmware_missing (NMDevice *device);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_device_get_nm_plugin_missing (NMDevice *device);
|
|
NMIPConfig * nm_device_get_ip4_config (NMDevice *device);
|
|
NMDhcpConfig * nm_device_get_dhcp4_config (NMDevice *device);
|
|
NMIPConfig * nm_device_get_ip6_config (NMDevice *device);
|
|
NMDhcpConfig * nm_device_get_dhcp6_config (NMDevice *device);
|
|
NMDeviceState nm_device_get_state (NMDevice *device);
|
|
NMDeviceStateReason nm_device_get_state_reason (NMDevice *device);
|
|
NMActiveConnection * nm_device_get_active_connection(NMDevice *device);
|
|
const GPtrArray * nm_device_get_available_connections(NMDevice *device);
|
|
const char * nm_device_get_physical_port_id (NMDevice *device);
|
|
guint32 nm_device_get_mtu (NMDevice *device);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_device_is_real (NMDevice *device);
|
|
gboolean nm_device_is_software (NMDevice *device);
|
|
|
|
const char * nm_device_get_product (NMDevice *device);
|
|
const char * nm_device_get_vendor (NMDevice *device);
|
|
const char * nm_device_get_description (NMDevice *device);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMMetered nm_device_get_metered (NMDevice *device);
|
|
NM_AVAILABLE_IN_1_2
|
|
GPtrArray * nm_device_get_lldp_neighbors (NMDevice *device);
|
|
char ** nm_device_disambiguate_names (NMDevice **devices,
|
|
int num_devices);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_device_reapply (NMDevice *device,
|
|
NMConnection *connection,
|
|
guint64 version_id,
|
|
guint32 flags,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
NM_AVAILABLE_IN_1_2
|
|
void nm_device_reapply_async (NMDevice *device,
|
|
NMConnection *connection,
|
|
guint64 version_id,
|
|
guint32 flags,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_device_reapply_finish (NMDevice *device,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
NMConnection *nm_device_get_applied_connection (NMDevice *device,
|
|
guint32 flags,
|
|
guint64 *version_id,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
NM_AVAILABLE_IN_1_2
|
|
void nm_device_get_applied_connection_async (NMDevice *device,
|
|
guint32 flags,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMConnection *nm_device_get_applied_connection_finish (NMDevice *device,
|
|
GAsyncResult *result,
|
|
guint64 *version_id,
|
|
GError **error);
|
|
|
|
gboolean nm_device_disconnect (NMDevice *device,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void nm_device_disconnect_async (NMDevice *device,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean nm_device_disconnect_finish (NMDevice *device,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
gboolean nm_device_delete (NMDevice *device,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
void nm_device_delete_async (NMDevice *device,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean nm_device_delete_finish (NMDevice *device,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
GPtrArray * nm_device_filter_connections (NMDevice *device,
|
|
const GPtrArray *connections);
|
|
|
|
gboolean nm_device_connection_valid (NMDevice *device,
|
|
NMConnection *connection);
|
|
|
|
gboolean nm_device_connection_compatible (NMDevice *device,
|
|
NMConnection *connection,
|
|
GError **error);
|
|
|
|
GType nm_device_get_setting_type (NMDevice *device);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
GType nm_lldp_neighbor_get_type (void);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMLldpNeighbor *nm_lldp_neighbor_new (void);
|
|
NM_AVAILABLE_IN_1_2
|
|
void nm_lldp_neighbor_ref (NMLldpNeighbor *neighbor);
|
|
NM_AVAILABLE_IN_1_2
|
|
void nm_lldp_neighbor_unref (NMLldpNeighbor *neighbor);
|
|
NM_AVAILABLE_IN_1_2
|
|
char **nm_lldp_neighbor_get_attr_names (NMLldpNeighbor *neighbor);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_lldp_neighbor_get_attr_string_value (NMLldpNeighbor *neighbor, char *name,
|
|
const char **out_value);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_lldp_neighbor_get_attr_uint_value (NMLldpNeighbor *neighbor, char *name,
|
|
guint *out_value);
|
|
NM_AVAILABLE_IN_1_2
|
|
const GVariantType *nm_lldp_neighbor_get_attr_type (NMLldpNeighbor *neighbor, char *name);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __NM_DEVICE_H__ */
|