Class IPRoute

Hierarchy

IPRoute

Index

Constructors

constructor

Properties

name

Constructors

constructor

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

- Defined in NM-1.0.d.ts:31893
Creates a new #NMIPRoute object.

Parameters
- family: number
  
  the IP address family (AF_INET or AF_INET6)
- dest: string
  
  the IP address of the route's destination
- prefix: number
  
  the address prefix length
- nextHop: string
  
  the IP address of the next hop (or %NULL)
- metric: number
  
  the route metric (or -1 for "default")
Returns IPRoute

Properties

Static name

name: string

Methods

dup

dup(): IPRoute

- Defined in NM-1.0.d.ts:31785
Creates a copy of route

Returns IPRoute

equal

equal(other: IPRoute): boolean

- Defined in NM-1.0.d.ts:31791
Determines if two #NMIPRoute objects contain the same destination, prefix, next hop, and metric. (Attributes are not compared.)

Parameters
- other: IPRoute
  
  the #NMIPRoute to compare route to.
Returns boolean

equalFull

equalFull(other: IPRoute, cmpFlags: number): boolean

- Defined in NM-1.0.d.ts:31798
Determines if two #NMIPRoute objects contain the same destination, prefix, next hop, and metric.

Parameters
- other: IPRoute
  
  the #NMIPRoute to compare route to.
- cmpFlags: 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

getAttribute

getAttribute(name: string): GLib.Variant

- Defined in NM-1.0.d.ts:31803
Gets the value of the attribute with name name on route

Parameters
- name: string
  
  the name of an route attribute
Returns GLib.Variant

getAttributeNames

getAttributeNames(): string[]

- Defined in NM-1.0.d.ts:31807
Gets an array of attribute names defined on route.

Returns string[]

getDest

getDest(): string

- Defined in NM-1.0.d.ts:31811
Gets the IP destination address property of this route object.

Returns string

getFamily

getFamily(): number

- Defined in NM-1.0.d.ts:31816
Gets the IP address family (eg, AF_INET) property of this route object.

Returns number

getMetric

getMetric(): number

- Defined in NM-1.0.d.ts:31822
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

getNextHop

getNextHop(): string

- Defined in NM-1.0.d.ts:31827
Gets the IP address of the next hop of this route; this will be %NULL if the route has no next hop.

Returns string

getPrefix

getPrefix(): number

- Defined in NM-1.0.d.ts:31831
Gets the IP prefix (ie "24" or "30" etc) of this route.

Returns number

ref

ref(): void

- Defined in NM-1.0.d.ts:31835
Increases the reference count of the object.

Returns void

setAttribute

setAttribute(name: string, value: GLib.Variant): void

- Defined in NM-1.0.d.ts:31841
Sets the named attribute on route to the given value.

Parameters
- name: string
  
  the name of a route attribute
- value: GLib.Variant
  
  the value
Returns void

setDest

setDest(dest: string): void

- Defined in NM-1.0.d.ts:31849
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_utils_ipaddr_is_valid() to check it.

Parameters
- dest: string
  
  the route's destination, as a string
Returns void

setMetric

setMetric(metric: number): void

- Defined in NM-1.0.d.ts:31854
Sets the metric property of this route object.

Parameters
- metric: number
  
  the route metric (or -1 for "default")
Returns void

setNextHop

setNextHop(nextHop: string): void

- Defined in NM-1.0.d.ts:31863
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
- nextHop: string
  
  the route's next hop, as a string
Returns void

setPrefix

setPrefix(prefix: number): void

- Defined in NM-1.0.d.ts:31868
Sets the prefix property of this route object.

Parameters
- prefix: number
  
  the route prefix
Returns void

unref

unref(): void

- Defined in NM-1.0.d.ts:31873
Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Returns void

Static attributeValidate

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

- Defined in NM-1.0.d.ts:31922
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]

Static getVariantAttributeSpec

getVariantAttributeSpec(): VariantAttributeSpec

- Defined in NM-1.0.d.ts:31923
Returns VariantAttributeSpec

Static new

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

- Defined in NM-1.0.d.ts:31903
Creates a new #NMIPRoute object.

Parameters
- family: number
  
  the IP address family (AF_INET or AF_INET6)
- dest: string
  
  the IP address of the route's destination
- prefix: number
  
  the address prefix length
- nextHop: string
  
  the IP address of the next hop (or %NULL)
- metric: number
  
  the route metric (or -1 for "default")
Returns IPRoute

Static newBinary

newBinary(family: number, dest: object, prefix: number, nextHop: object, metric: number): IPRoute

- Defined in NM-1.0.d.ts:31914
Creates a new #NMIPRoute object. dest and next_hop (if non-%NULL) must point to buffers of the correct size for family.

Parameters
- family: number
  
  the IP address family (AF_INET or AF_INET6)
- dest: object
  
  the IP address of the route's destination
- prefix: number
  
  the address prefix length
- nextHop: object
  
  the IP address of the next hop (or %NULL)
- metric: number
  
  the route metric (or -1 for "default")
Returns IPRoute