GI.NM.Structs.LldpNeighbor

Supported attributes are:

• LLDP_ATTR_CHASSIS_ID_TYPE (type: 'u')
• LLDP_ATTR_CHASSIS_ID (type: 's')
• LLDP_ATTR_DESTINATION (type: 's')
• 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.
• 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.
• LLDP_ATTR_IEEE_802_1_PPVIDS (type: 'aa{sv}')

An array of dictionaries where each element has keys:

• flags (type: 'u')
• ppvid (type: 'u')
• LLDP_ATTR_IEEE_802_1_PVID (type: 'u')
• 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.
• 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.
• LLDP_ATTR_IEEE_802_1_VLANS (type: 'aa{sv}')

An array of dictionaries where each element has keys:

• name (type: 's')
• vid (type: 'u')
• 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')

• LLDP_ATTR_IEEE_802_3_MAX_FRAME_SIZE (type: 'u')
• 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')

• 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')

• LLDP_ATTR_PORT_DESCRIPTION (type: 's')
• LLDP_ATTR_PORT_ID_TYPE (type: 'u')
• LLDP_ATTR_PORT_ID (type: 's')
• LLDP_ATTR_RAW (type: 'ay')
• LLDP_ATTR_SYSTEM_CAPABILITIES (type: 'u')
• LLDP_ATTR_SYSTEM_DESCRIPTION (type: 's')
• LLDP_ATTR_SYSTEM_NAME (type: 's')

Exported types

newtype LldpNeighbor

Memory-managed wrapper type.

Constructors

LldpNeighbor (ManagedPtr LldpNeighbor)

Instances

Eq LldpNeighbor

Defined in GI.NM.Structs.LldpNeighbor

Methods

(==) :: LldpNeighbor -> LldpNeighbor -> Bool

(/=) :: LldpNeighbor -> LldpNeighbor -> Bool

GBoxed LldpNeighbor

Defined in GI.NM.Structs.LldpNeighbor

ManagedPtrNewtype LldpNeighbor

Defined in GI.NM.Structs.LldpNeighbor

Methods

toManagedPtr :: LldpNeighbor -> ManagedPtr LldpNeighbor

TypedObject LldpNeighbor

Defined in GI.NM.Structs.LldpNeighbor

Methods

glibType :: IO GType

HasParentTypes LldpNeighbor

Defined in GI.NM.Structs.LldpNeighbor

IsGValue (Maybe LldpNeighbor)

Convert LldpNeighbor to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Structs.LldpNeighbor

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe LldpNeighbor -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe LldpNeighbor)

type ParentTypes LldpNeighbor

Defined in GI.NM.Structs.LldpNeighbor

type ParentTypes LldpNeighbor = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

ref, unref.

Getters

getAttrNames, getAttrStringValue, getAttrType, getAttrUintValue, getAttrValue.

Setters

None.

getAttrNames

lldpNeighborGetAttrNames

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> m [Text]

Returns: a Nothing-terminated array of attribute names.

Gets an array of attribute names available for neighbor.

Since: 1.2

getAttrStringValue

lldpNeighborGetAttrStringValue

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> Text

name: the attribute name

-> m (Bool, Maybe Text)

Returns: True if a string attribute with name name was found, False otherwise

Gets the string value of attribute with name name on neighbor

Since: 1.2

getAttrType

lldpNeighborGetAttrType

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> Text

name: the attribute name

-> m VariantType

Returns: the VariantType of the attribute with name name

Get the type of an attribute.

Since: 1.2

getAttrUintValue

lldpNeighborGetAttrUintValue

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> Text

name: the attribute name

-> m (Bool, Word32)

Returns: True if a uint32 attribute with name name was found, False otherwise

Gets the uint32 value of attribute with name name on neighbor

Since: 1.2

getAttrValue

lldpNeighborGetAttrValue

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> Text

name: the attribute name

-> m GVariant

Returns: the value or Nothing if the attribute with name was not found.

Gets the value (as a GVariant) of attribute with name name on neighbor

Since: 1.18

new

lldpNeighborNew

Arguments

:: (HasCallStack, MonadIO m)

=> m LldpNeighbor

Returns: the new LldpNeighbor object.

Creates a new LldpNeighbor object.

Note that LldpNeighbor has no public API for mutating an instance. Also, libnm will not internally mutate a once exposed object. They are guaranteed to be immutable.

Since 1.32, ref-counting of LldpNeighbor is thread-safe.

This function is not useful, as there is no public API to actually modify the (empty) instance.

Since: 1.2

ref

lldpNeighborRef

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> m ()

Increases the reference count of the object.

Since 1.32, ref-counting of LldpNeighbor is thread-safe.

Since: 1.2

unref

lldpNeighborUnref

Arguments

:: (HasCallStack, MonadIO m)

=> LldpNeighbor

neighbor: the LldpNeighbor

-> m ()

Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Since 1.32, ref-counting of LldpNeighbor is thread-safe.

Since: 1.2