mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-05-28 06:08:15 +02:00
8eb1bfa87f
We keep adding capabilities. Tracking them individually via boolean (or ternary) properties is cumbersome. Instead, use an enum NMSupplCapType and a corresponding bitmask NMSupplCapMask. The latter can track whether a capability is detected, detected to be absent or not detected (unknown).
168 lines
8 KiB
C
168 lines
8 KiB
C
// SPDX-License-Identifier: GPL-2.0+
|
|
/*
|
|
* Copyright (C) 2006 - 2017 Red Hat, Inc.
|
|
* Copyright (C) 2007 - 2008 Novell, Inc.
|
|
*/
|
|
|
|
#ifndef __NM_SUPPLICANT_INTERFACE_H__
|
|
#define __NM_SUPPLICANT_INTERFACE_H__
|
|
|
|
#include "nm-supplicant-types.h"
|
|
|
|
/*
|
|
* Supplicant interface states
|
|
* A mix of wpa_supplicant interface states and internal states.
|
|
*/
|
|
typedef enum {
|
|
NM_SUPPLICANT_INTERFACE_STATE_INVALID = -1,
|
|
NM_SUPPLICANT_INTERFACE_STATE_INIT = 0,
|
|
NM_SUPPLICANT_INTERFACE_STATE_STARTING,
|
|
NM_SUPPLICANT_INTERFACE_STATE_READY,
|
|
NM_SUPPLICANT_INTERFACE_STATE_DISABLED,
|
|
NM_SUPPLICANT_INTERFACE_STATE_DISCONNECTED,
|
|
NM_SUPPLICANT_INTERFACE_STATE_INACTIVE,
|
|
NM_SUPPLICANT_INTERFACE_STATE_SCANNING,
|
|
NM_SUPPLICANT_INTERFACE_STATE_AUTHENTICATING,
|
|
NM_SUPPLICANT_INTERFACE_STATE_ASSOCIATING,
|
|
NM_SUPPLICANT_INTERFACE_STATE_ASSOCIATED,
|
|
NM_SUPPLICANT_INTERFACE_STATE_4WAY_HANDSHAKE,
|
|
NM_SUPPLICANT_INTERFACE_STATE_GROUP_HANDSHAKE,
|
|
NM_SUPPLICANT_INTERFACE_STATE_COMPLETED,
|
|
NM_SUPPLICANT_INTERFACE_STATE_DOWN,
|
|
} NMSupplicantInterfaceState;
|
|
|
|
typedef enum {
|
|
NM_SUPPLICANT_AUTH_STATE_UNKNOWN,
|
|
NM_SUPPLICANT_AUTH_STATE_STARTED,
|
|
NM_SUPPLICANT_AUTH_STATE_SUCCESS,
|
|
NM_SUPPLICANT_AUTH_STATE_FAILURE,
|
|
_NM_SUPPLICANT_AUTH_STATE_NUM,
|
|
} NMSupplicantAuthState;
|
|
|
|
#define NM_TYPE_SUPPLICANT_INTERFACE (nm_supplicant_interface_get_type ())
|
|
#define NM_SUPPLICANT_INTERFACE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SUPPLICANT_INTERFACE, NMSupplicantInterface))
|
|
#define NM_SUPPLICANT_INTERFACE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SUPPLICANT_INTERFACE, NMSupplicantInterfaceClass))
|
|
#define NM_IS_SUPPLICANT_INTERFACE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SUPPLICANT_INTERFACE))
|
|
#define NM_IS_SUPPLICANT_INTERFACE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SUPPLICANT_INTERFACE))
|
|
#define NM_SUPPLICANT_INTERFACE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SUPPLICANT_INTERFACE, NMSupplicantInterfaceClass))
|
|
|
|
#define NM_SUPPLICANT_INTERFACE_IFACE "iface"
|
|
#define NM_SUPPLICANT_INTERFACE_OBJECT_PATH "object-path"
|
|
#define NM_SUPPLICANT_INTERFACE_SCANNING "scanning"
|
|
#define NM_SUPPLICANT_INTERFACE_CURRENT_BSS "current-bss"
|
|
#define NM_SUPPLICANT_INTERFACE_P2P_GROUP_JOINED "p2p-group-joined"
|
|
#define NM_SUPPLICANT_INTERFACE_P2P_GROUP_PATH "p2p-group-path"
|
|
#define NM_SUPPLICANT_INTERFACE_P2P_GROUP_OWNER "p2p-group-owner"
|
|
#define NM_SUPPLICANT_INTERFACE_DRIVER "driver"
|
|
#define NM_SUPPLICANT_INTERFACE_P2P_AVAILABLE "p2p-available"
|
|
#define NM_SUPPLICANT_INTERFACE_GLOBAL_CAPABILITIES "global-capabilities"
|
|
#define NM_SUPPLICANT_INTERFACE_AUTH_STATE "auth-state"
|
|
|
|
#define NM_SUPPLICANT_INTERFACE_STATE "state"
|
|
#define NM_SUPPLICANT_INTERFACE_REMOVED "removed"
|
|
#define NM_SUPPLICANT_INTERFACE_BSS_UPDATED "bss-updated"
|
|
#define NM_SUPPLICANT_INTERFACE_BSS_REMOVED "bss-removed"
|
|
#define NM_SUPPLICANT_INTERFACE_PEER_UPDATED "peer-updated"
|
|
#define NM_SUPPLICANT_INTERFACE_PEER_REMOVED "peer-removed"
|
|
#define NM_SUPPLICANT_INTERFACE_SCAN_DONE "scan-done"
|
|
#define NM_SUPPLICANT_INTERFACE_CREDENTIALS_REQUEST "credentials-request"
|
|
#define NM_SUPPLICANT_INTERFACE_WPS_CREDENTIALS "wps-credentials"
|
|
#define NM_SUPPLICANT_INTERFACE_GROUP_STARTED "group-started"
|
|
#define NM_SUPPLICANT_INTERFACE_GROUP_FINISHED "group-finished"
|
|
|
|
typedef struct _NMSupplicantInterfaceClass NMSupplicantInterfaceClass;
|
|
|
|
GType nm_supplicant_interface_get_type (void);
|
|
|
|
NMSupplicantInterface *nm_supplicant_interface_new (const char *ifname,
|
|
const char *object_path,
|
|
NMSupplicantDriver driver,
|
|
NMSupplCapMask global_capabilities);
|
|
|
|
void nm_supplicant_interface_set_supplicant_available (NMSupplicantInterface *self,
|
|
gboolean available);
|
|
|
|
typedef void (*NMSupplicantInterfaceAssocCb) (NMSupplicantInterface *iface,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
void
|
|
nm_supplicant_interface_assoc (NMSupplicantInterface *self,
|
|
NMSupplicantConfig *cfg,
|
|
NMSupplicantInterfaceAssocCb callback,
|
|
gpointer user_data);
|
|
|
|
void nm_supplicant_interface_disconnect (NMSupplicantInterface * iface);
|
|
|
|
typedef void (*NMSupplicantInterfaceDisconnectCb) (NMSupplicantInterface *iface,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
void
|
|
nm_supplicant_interface_disconnect_async (NMSupplicantInterface * self,
|
|
GCancellable * cancellable,
|
|
NMSupplicantInterfaceDisconnectCb callback,
|
|
gpointer user_data);
|
|
|
|
const char *nm_supplicant_interface_get_object_path (NMSupplicantInterface * iface);
|
|
|
|
void nm_supplicant_interface_request_scan (NMSupplicantInterface *self,
|
|
GBytes *const*ssids,
|
|
guint ssids_len);
|
|
|
|
NMSupplicantInterfaceState nm_supplicant_interface_get_state (NMSupplicantInterface * self);
|
|
|
|
const char *nm_supplicant_interface_state_to_string (NMSupplicantInterfaceState state);
|
|
|
|
gboolean nm_supplicant_interface_get_scanning (NMSupplicantInterface *self);
|
|
|
|
const char *nm_supplicant_interface_get_current_bss (NMSupplicantInterface *self);
|
|
|
|
gint64 nm_supplicant_interface_get_last_scan (NMSupplicantInterface *self);
|
|
|
|
const char *nm_supplicant_interface_get_ifname (NMSupplicantInterface *self);
|
|
|
|
guint nm_supplicant_interface_get_max_scan_ssids (NMSupplicantInterface *self);
|
|
|
|
gboolean nm_supplicant_interface_get_has_credentials_request (NMSupplicantInterface *self);
|
|
|
|
gboolean nm_supplicant_interface_get_p2p_group_joined (NMSupplicantInterface *self);
|
|
|
|
const char* nm_supplicant_interface_get_p2p_group_path (NMSupplicantInterface *self);
|
|
|
|
gboolean nm_supplicant_interface_get_p2p_group_owner (NMSupplicantInterface *self);
|
|
|
|
gboolean nm_supplicant_interface_credentials_reply (NMSupplicantInterface *self,
|
|
const char *field,
|
|
const char *value,
|
|
GError **error);
|
|
|
|
void nm_supplicant_interface_p2p_start_find (NMSupplicantInterface *self,
|
|
guint timeout);
|
|
void nm_supplicant_interface_p2p_stop_find (NMSupplicantInterface *self);
|
|
|
|
void nm_supplicant_interface_p2p_connect (NMSupplicantInterface * self,
|
|
const char * peer,
|
|
const char * wps_method,
|
|
const char * wps_pin);
|
|
void nm_supplicant_interface_p2p_cancel_connect (NMSupplicantInterface * self);
|
|
void nm_supplicant_interface_p2p_disconnect (NMSupplicantInterface * self);
|
|
|
|
void nm_supplicant_interface_set_global_capabilities (NMSupplicantInterface *self,
|
|
NMSupplCapMask value);
|
|
|
|
NMTernary nm_supplicant_interface_get_capability (NMSupplicantInterface *self,
|
|
NMSupplCapType type);
|
|
|
|
NMSupplCapMask nm_supplicant_interface_get_capabilities (NMSupplicantInterface *self);
|
|
|
|
void nm_supplicant_interface_enroll_wps (NMSupplicantInterface *self,
|
|
const char *const type,
|
|
const char *bssid,
|
|
const char *pin);
|
|
|
|
void nm_supplicant_interface_cancel_wps (NMSupplicantInterface *self);
|
|
|
|
NMSupplicantAuthState nm_supplicant_interface_get_auth_state (NMSupplicantInterface *self);
|
|
|
|
#endif /* __NM_SUPPLICANT_INTERFACE_H__ */
|