NM-1.0 ▶ NM ▶ BridgeVlan

constructor

• new BridgeVlan(vid_start: number, vid_end: number): BridgeVlan

  Parameters

  • vid_start: number
  • vid_end: number

  Returns BridgeVlan

Static$gtype

cmp

• cmp(b: BridgeVlan): number

  Compare two bridge VLAN objects.

  Parameters

  • b: BridgeVlan

    another NM.BridgeVlan

  Returns number

  zero of the two instances are equivalent or a non-zero integer otherwise. This defines a total ordering over the VLANs. Whether a VLAN is sealed or not does not affect the comparison.

get_vid_range

• get_vid_range(): [boolean, number, number]

  Gets the VLAN id range.

  Returns [boolean, number, number]

  true is the VLAN specifies a range, false if it is a single-id VLAN.

is_pvid

• is_pvid(): boolean

  Returns whether the VLAN is the PVID for the port.

  Returns boolean

  true if the VLAN is the PVID

is_sealed

• is_sealed(): boolean

  Returns boolean

  whether self is sealed or not.

is_untagged

• is_untagged(): boolean

  Returns whether the VLAN is untagged.

  Returns boolean

  true if the VLAN is untagged, false otherwise

new_clone

• new_clone(): BridgeVlan

  Returns BridgeVlan

  a clone of vlan. This instance is always unsealed.

ref

• ref(): BridgeVlan

  Increases the reference count of the object.

  Returns BridgeVlan

  the input argument vlan object. Since 1.42, ref-counting of NM.BridgeVlan is thread-safe.

seal

• seal(): void

  Seal the NM.BridgeVlan instance. Afterwards, it is a bug to call all functions that modify the instance (except ref/unref). A sealed instance cannot be unsealed again, but you can create an unsealed copy with nm_bridge_vlan_new_clone().

  Returns void

set_pvid

• set_pvid(value: boolean): void

  Change the value of the PVID property of the VLAN. It is invalid to set the value to true for non-single-id VLANs.

  Parameters

  • value: boolean

    the new value

  Returns void

set_untagged

• set_untagged(value: boolean): void

  Change the value of the untagged property of the VLAN.

  Parameters

  • value: boolean

    the new value

  Returns void

to_str

• to_str(): string

  Convert a %NMBridgeVlan to a string.

  Returns string

  formatted string or null

unref

• unref(): void

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

  Since 1.42, ref-counting of NM.BridgeVlan is thread-safe.

  Returns void

Staticfrom_str

• from_str(str: string): BridgeVlan

  Parses the string representation of the queueing discipline to a %NMBridgeVlan instance.

  Parameters

  • str: string

    the string representation of a bridge VLAN

  Returns BridgeVlan

Staticnew

• new(vid_start: number, vid_end: number): BridgeVlan

  Parameters

  • vid_start: number
  • vid_end: number

  Returns BridgeVlan