NM-1.0 ▶ NM ▶ IPAddress

constructor

• new IPAddress(family: number, addr: string, prefix: number): IPAddress

  Parameters

  • family: number
  • addr: string
  • prefix: number

  Returns IPAddress

Static$gtype

cmp_full

• cmp_full(b: IPAddress, cmp_flags: NM.IPAddressCmpFlags): number

  Note that with cmp_flags #NM_IP_ADDRESS_CMP_FLAGS_WITH_ATTRS, there is no total order for comparing GVariant. That means, if the two addresses only differ by their attributes, the sort order is undefined and the return value only indicates equality.

  Parameters

  • b: IPAddress

    the NM.IPAddress to compare address to.

  • cmp_flags: NM.IPAddressCmpFlags

    the NM.IPAddressCmpFlags that indicate what to compare.

  Returns number

  0 if the two objects have the same values (according to their flags) or a integer indicating the compare order.

dup

• dup(): IPAddress

  Creates a copy of address

  Returns IPAddress

  a copy of address This API was part of public headers before 1.32.0 but was erroneously not exported in the ABI. It is thus only usable since 1.32.0.

equal

• equal(other: IPAddress): boolean

  Determines if two NM.IPAddress objects contain the same address and prefix (attributes are not compared).

  Parameters

  • other: IPAddress

    the NM.IPAddress to compare address to.

  Returns boolean

  true if the objects contain the same values, false if they do not.

get_address

• get_address(): string

  Gets the IP address property of this address object.

  Returns string

  the IP address

get_attribute

• get_attribute(name: string): GLib.Variant

  Gets the value of the attribute with name name on address

  Parameters

  • name: string

    the name of an address attribute

  Returns GLib.Variant

  the value of the attribute with name name on address, or null if address has no such attribute.

get_attribute_names

• get_attribute_names(): string[]

  Gets an array of attribute names defined on address.

  Returns string[]

  a null-terminated array of attribute names,

get_family

• get_family(): number

  Gets the IP address family (eg, AF_INET) property of this address object.

  Returns number

  the IP address family

get_prefix

• get_prefix(): number

  Gets the IP address prefix (ie "24" or "30" etc) property of this address object.

  Returns number

  the IP address prefix

ref

• ref(): void

  Increases the reference count of the object.

  Returns void

set_address

• set_address(addr: string): void

  Sets the IP address property of this address object.

  addr must be a valid address of address's family. If you aren't sure you have a valid address, use nm_utils_ipaddr_valid() to check it.

  Parameters

  • addr: string

    the IP address, as a string

  Returns void

set_attribute

• set_attribute(name: string, value?: GLib.Variant<any>): void

  Sets or clears the named attribute on address to the given value.

  Parameters

  • name: string

    the name of an address attribute

  • Optionalvalue: GLib.Variant<any>

    the value

  Returns void

set_prefix

• set_prefix(prefix: number): void

  Sets the IP address prefix property of this address object.

  Parameters

  • prefix: number

    the IP address prefix

  Returns void

unref

• unref(): void

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

  Returns void

Staticnew

• new(family: number, addr: string, prefix: number): IPAddress

  Parameters

  • family: number
  • addr: string
  • prefix: number

  Returns IPAddress

Staticnew_binary

• new_binary(family: number, addr: any, prefix: number): IPAddress

  Parameters

  • family: number
  • addr: any
  • prefix: number

  Returns IPAddress