colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

device/factory: document that some callbacks get an incomplete connection

Browse Source 
It's get_connection_parent() and get_connection_iface().
This commit is contained in:
Lubomir Rintel
2024-12-12 21:06:10 +01:00
parent f7a30b3241
commit e3d3f1315a
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/core/devices/nm-device-factory.h
View File

@@ -69,11 +69,15 @@ typedef struct {
/** /**
* get_connection_parent: * get_connection_parent:
* @factory: the #NMDeviceFactory * @factory: the #NMDeviceFactory
* @connection: the #NMConnection to return the parent name for, if supported * @connection: the #NMConnection (possibly incomplete) to return the parent name for, if supported
* *
* Given a connection, returns the parent interface name, parent connection * Given a connection, returns the parent interface name, parent connection
* UUID, or parent device permanent hardware address for @connection. * UUID, or parent device permanent hardware address for @connection.
* *
* Note that @connection is not necessarily a valid connection.
* It might be called during AddAndActivate before the connection is
* completed and normalized.
*
* Returns: the parent interface name, parent connection UUID, parent * Returns: the parent interface name, parent connection UUID, parent
* device permanent hardware address, or %NULL * device permanent hardware address, or %NULL
*/ */
@@ -82,12 +86,16 @@ typedef struct {
/** /**
* get_connection_iface: * get_connection_iface:
* @factory: the #NMDeviceFactory * @factory: the #NMDeviceFactory
* @connection: the #NMConnection to return the interface name for * @connection: the #NMConnection (possibly incomplete) to return the interface name for
* @parent_iface: optional parent interface name for virtual devices * @parent_iface: optional parent interface name for virtual devices
* *
* Given a connection, returns the interface name that a device activating * Given a connection, returns the interface name that a device activating
* that connection would have. * that connection would have.
* *
* Note that @connection is not necessarily a valid connection.
* It might be called during AddAndActivate before the connection is
* completed and normalized.
*
* Returns: the interface name, or %NULL * Returns: the interface name, or %NULL
*/ */
char *(*get_connection_iface)(NMDeviceFactory *factory, char *(*get_connection_iface)(NMDeviceFactory *factory,