NM-1.0 ▶ NM ▶ IPRoute

constructor

• new IPRoute(
      family: number,
      dest: string,
      prefix: number,
      next_hop: string,
      metric: number,
  ): IPRoute

  Parameters

  • family: number
  • dest: string
  • prefix: number
  • next_hop: string
  • metric: number

  Returns IPRoute

Static$gtype

dup

• dup(): IPRoute

  Creates a copy of route

  Returns IPRoute

  a copy of route 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: IPRoute): boolean

  Determines if two NM.IPRoute objects contain the same destination, prefix, next hop, and metric. (Attributes are not compared.)

  Parameters

  • other: IPRoute

    the NM.IPRoute to compare route to.

  Returns boolean

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

equal_full

• equal_full(other: IPRoute, cmp_flags: number): boolean

  Determines if two NM.IPRoute objects contain the same destination, prefix, next hop, and metric.

  Parameters

  • other: IPRoute

    the NM.IPRoute to compare route to.

  • cmp_flags: number

    tune how to compare attributes. Currently, only NM_IP_ROUTE_EQUAL_CMP_FLAGS_NONE (0) and NM_IP_ROUTE_EQUAL_CMP_FLAGS_WITH_ATTRS (1) is supported.

  Returns boolean

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

get_attribute

• get_attribute(name: string): GLib.Variant

  Gets the value of the attribute with name name on route

  Parameters

  • name: string

    the name of an route attribute

  Returns GLib.Variant

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

get_attribute_names

• get_attribute_names(): string[]

  Gets an array of attribute names defined on route.

  Returns string[]

  a null-terminated array of attribute names

get_dest

• get_dest(): string

  Gets the IP destination address property of this route object.

  Returns string

  the IP address of the route's destination

get_family

• get_family(): number

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

  Returns number

  the IP address family

get_metric

• get_metric(): number

  Gets the route metric property of this route object; lower values indicate "better" or more preferred routes; -1 indicates "default" (meaning NetworkManager will set it appropriately).

  Returns number

  the route metric

get_next_hop

• get_next_hop(): string

  Gets the IP address of the next hop of this route; this will be null if the route has no next hop.

  Returns string

  the IP address of the next hop, or null if this is a device route.

get_prefix

• get_prefix(): number

  Gets the IP prefix (ie "24" or "30" etc) of this route.

  Returns number

  the IP prefix

ref

• ref(): void

  Increases the reference count of the object.

  Returns void

set_attribute

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

  Sets the named attribute on route to the given value.

  Parameters

  • name: string

    the name of a route attribute

  • Optionalvalue: GLib.Variant<any>

    the value

  Returns void

set_dest

• set_dest(dest: string): void

  Sets the destination property of this route object.

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

  Parameters

  • dest: string

    the route's destination, as a string

  Returns void

set_metric

• set_metric(metric: number): void

  Sets the metric property of this route object.

  Parameters

  • metric: number

    the route metric (or -1 for "default")

  Returns void

set_next_hop

• set_next_hop(next_hop?: string): void

  Sets the next-hop property of this route object.

  next_hop (if non-null) must be a valid address of route's family. If you aren't sure you have a valid address, use nm_utils_ipaddr_valid() to check it.

  Parameters

  • Optionalnext_hop: string

    the route's next hop, as a string

  Returns void

set_prefix

• set_prefix(prefix: number): void

  Sets the prefix property of this route object.

  Parameters

  • prefix: number

    the route 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

Staticattribute_validate

• attribute_validate(
      name: string,
      value: GLib.Variant,
      family: number,
  ): [boolean, boolean]

  Validates a route attribute, i.e. checks that the attribute is a known one and the value is of the correct type and well-formed.

  Parameters

  • name: string

    the attribute name

  • value: GLib.Variant

    the attribute value

  • family: number

    IP address family of the route

  Returns [boolean, boolean]

Staticget_variant_attribute_spec

• get_variant_attribute_spec(): VariantAttributeSpec

  Returns VariantAttributeSpec

Staticnew

• new(
      family: number,
      dest: string,
      prefix: number,
      next_hop: string,
      metric: number,
  ): IPRoute

  Parameters

  • family: number
  • dest: string
  • prefix: number
  • next_hop: string
  • metric: number

  Returns IPRoute

Staticnew_binary

• new_binary(
      family: number,
      dest: any,
      prefix: number,
      next_hop: any,
      metric: number,
  ): IPRoute

  Parameters

  • family: number
  • dest: any
  • prefix: number
  • next_hop: any
  • metric: number

  Returns IPRoute