about summary refs log tree commit diff
path: root/src/libnm-client-public/nm-active-connection.h
blob: b4391d0fcc8fe84034dda84c21c9c0edaee04cde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2007 - 2014 Red Hat, Inc.
 * Copyright (C) 2008 Novell, Inc.
 */

#ifndef __NM_ACTIVE_CONNECTION_H__
#define __NM_ACTIVE_CONNECTION_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_ACTIVE_CONNECTION (nm_active_connection_get_type())
#define NM_ACTIVE_CONNECTION(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST((obj), NM_TYPE_ACTIVE_CONNECTION, NMActiveConnection))
#define NM_ACTIVE_CONNECTION_CLASS(klass) \
    (G_TYPE_CHECK_CLASS_CAST((klass), NM_TYPE_ACTIVE_CONNECTION, NMActiveConnectionClass))
#define NM_IS_ACTIVE_CONNECTION(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), NM_TYPE_ACTIVE_CONNECTION))
#define NM_IS_ACTIVE_CONNECTION_CLASS(klass) \
    (G_TYPE_CHECK_CLASS_TYPE((klass), NM_TYPE_ACTIVE_CONNECTION))
#define NM_ACTIVE_CONNECTION_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS((obj), NM_TYPE_ACTIVE_CONNECTION, NMActiveConnectionClass))

#define NM_ACTIVE_CONNECTION_CONNECTION           "connection"
#define NM_ACTIVE_CONNECTION_ID                   "id"
#define NM_ACTIVE_CONNECTION_UUID                 "uuid"
#define NM_ACTIVE_CONNECTION_TYPE                 "type"
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH "specific-object-path"
#define NM_ACTIVE_CONNECTION_DEVICES              "devices"
#define NM_ACTIVE_CONNECTION_STATE                "state"
#define NM_ACTIVE_CONNECTION_STATE_FLAGS          "state-flags"
#define NM_ACTIVE_CONNECTION_DEFAULT              "default"
#define NM_ACTIVE_CONNECTION_IP4_CONFIG           "ip4-config"
#define NM_ACTIVE_CONNECTION_DHCP4_CONFIG         "dhcp4-config"
#define NM_ACTIVE_CONNECTION_DEFAULT6             "default6"
#define NM_ACTIVE_CONNECTION_IP6_CONFIG           "ip6-config"
#define NM_ACTIVE_CONNECTION_DHCP6_CONFIG         "dhcp6-config"
#define NM_ACTIVE_CONNECTION_VPN                  "vpn"
#define NM_ACTIVE_CONNECTION_MASTER               "master"
#define NM_ACTIVE_CONNECTION_CONTROLLER           "controller"

/**
 * NMActiveConnection:
 */
typedef struct _NMActiveConnection      NMActiveConnection;
typedef struct _NMActiveConnectionClass NMActiveConnectionClass;

GType nm_active_connection_get_type(void);

NMRemoteConnection *nm_active_connection_get_connection(NMActiveConnection *connection);
const char         *nm_active_connection_get_id(NMActiveConnection *connection);
const char         *nm_active_connection_get_uuid(NMActiveConnection *connection);
const char         *nm_active_connection_get_connection_type(NMActiveConnection *connection);
const char         *nm_active_connection_get_specific_object_path(NMActiveConnection *connection);
const GPtrArray    *nm_active_connection_get_devices(NMActiveConnection *connection);
NMActiveConnectionState nm_active_connection_get_state(NMActiveConnection *connection);
NM_AVAILABLE_IN_1_10
NMActivationStateFlags nm_active_connection_get_state_flags(NMActiveConnection *connection);
NM_AVAILABLE_IN_1_8
NMActiveConnectionStateReason nm_active_connection_get_state_reason(NMActiveConnection *connection);

struct _NMDevice;

_NM_DEPRECATED_INCLUSIVE_LANGUAGE_1_44
struct _NMDevice *nm_active_connection_get_master(NMActiveConnection *connection);
NM_AVAILABLE_IN_1_44
struct _NMDevice *nm_active_connection_get_controller(NMActiveConnection *connection);

gboolean      nm_active_connection_get_default(NMActiveConnection *connection);
NMIPConfig   *nm_active_connection_get_ip4_config(NMActiveConnection *connection);
NMDhcpConfig *nm_active_connection_get_dhcp4_config(NMActiveConnection *connection);
gboolean      nm_active_connection_get_default6(NMActiveConnection *connection);
NMIPConfig   *nm_active_connection_get_ip6_config(NMActiveConnection *connection);
NMDhcpConfig *nm_active_connection_get_dhcp6_config(NMActiveConnection *connection);
gboolean      nm_active_connection_get_vpn(NMActiveConnection *connection);

G_END_DECLS

#endif /* __NM_ACTIVE_CONNECTION_H__ */