system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-10-06 16:21:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

libnm/doc: document the type of each LLDP attribute of libnm

Browse source 
Signed-off-by: Wen Liang <liangwen12year@gmail.com>

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/777
This commit is contained in:
Wen Liang 2021-03-09 21:24:18 -05:00 committed by Thomas Haller
parent 48c0305bb2
commit ec3e2561a8
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 60 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
src/libnm-client-public/nm-device.h
View file

@ -63,6 +63,66 @@ _NM_DEPRECATED_SYNC_WRITABLE_PROPERTY
*/
typedef struct _NMDeviceClass NMDeviceClass;
/**
* NMLldpNeighbor:
*
* Supported attributes are:
*
* - #NM_LLDP_ATTR_CHASSIS_ID_TYPE (type: 'u')
* - #NM_LLDP_ATTR_CHASSIS_ID (type: 's')
* - #NM_LLDP_ATTR_DESTINATION (type: 's')
* - #NM_LLDP_ATTR_IEEE_802_1_PPVID (type: 'u'). This attribute only reports the first PPVID
* and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_PPVIDS which reports
* all the PPVID.
* - #NM_LLDP_ATTR_IEEE_802_1_PPVID_FLAGS (type: 'u'). This attribute only reports the first PPVID
* and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_PPVIDS which reports
* all the PPVID.
* - #NM_LLDP_ATTR_IEEE_802_1_PPVIDS (type: 'aa{sv}')
*
* An array of dictionaries where each element has keys:
* - flags (type: 'u')
* - ppvid (type: 'u')
* - #NM_LLDP_ATTR_IEEE_802_1_PVID (type: 'u')
* - #NM_LLDP_ATTR_IEEE_802_1_VID (type: 'u'). This attribute only reports the first VLAN
* and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_VLANS which reports
* all the VLANs.
* - #NM_LLDP_ATTR_IEEE_802_1_VLAN_NAME (type: 's'). This attribute only reports the first VLAN
* and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_VLANS which reports
* all the VLANs.
* - #NM_LLDP_ATTR_IEEE_802_1_VLANS (type: 'aa{sv}')
*
* An array of dictionaries where each element has keys:
* - name (type: 's')
* - vid (type: 'u')
* - #NM_LLDP_ATTR_IEEE_802_3_MAC_PHY_CONF (type: 'a{sv}')
*
* Dictionary where each element has keys:
* - autoneg (type: 'u')
* - operational-mau-type (type: 'u')
* - pmd-autoneg-cap (type: 'u')
* - #NM_LLDP_ATTR_IEEE_802_3_MAX_FRAME_SIZE (type: 'u')
* - #NM_LLDP_ATTR_IEEE_802_3_POWER_VIA_MDI (type: 'a{sv}')
*
* Dictionary where each element has keys:
* - mdi-power-support (type: 'u')
* - power-class (type: 'u')
* - pse-power-pair (type: 'u')
* - #NM_LLDP_ATTR_MANAGEMENT_ADDRESSES (type: 'aa{sv}')
*
* An array of dictionaries where each element has keys:
* - address (type: 'ay')
* - address-subtype (type: 'u')
* - interface-number (type: 'u')
* - interface-number-subtype (type: 'u')
* - object-id (type: 'ay')
* - #NM_LLDP_ATTR_PORT_DESCRIPTION (type: 's')
* - #NM_LLDP_ATTR_PORT_ID_TYPE (type: 'u')
* - #NM_LLDP_ATTR_PORT_ID (type: 's')
* - #NM_LLDP_ATTR_RAW (type: 'ay')
* - #NM_LLDP_ATTR_SYSTEM_CAPABILITIES (type: 'u')
* - #NM_LLDP_ATTR_SYSTEM_DESCRIPTION (type: 's')
* - #NM_LLDP_ATTR_SYSTEM_NAME (type: 's')
**/
typedef struct _NMLldpNeighbor NMLldpNeighbor;
GType nm_device_get_type(void);