Class IPAddress

Hierarchy

IPAddress

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

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

- Defined in @types/Gjs/NM-1.0.d.ts:28114
Creates a new #NMIPAddress object.

Parameters
- family: number
  
  the IP address family (AF_INET or AF_INET6)
- addr: string
  
  the IP address
- prefix: number
  
  the address prefix length
Returns IPAddress

Properties

Static name

name: string

Methods

cmp_full

cmp_full(b: IPAddress, cmp_flags: IPAddressCmpFlags): number

- Defined in @types/Gjs/NM-1.0.d.ts:28035
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 #NMIPAddress to compare address to.
- cmp_flags: IPAddressCmpFlags
  
  the #NMIPAddressCmpFlags that indicate what to compare.
Returns number

dup

dup(): IPAddress

- Defined in @types/Gjs/NM-1.0.d.ts:28039
Creates a copy of address

Returns IPAddress

equal

equal(other: IPAddress): boolean

- Defined in @types/Gjs/NM-1.0.d.ts:28045
Determines if two #NMIPAddress objects contain the same address and prefix (attributes are not compared).

Parameters
- other: IPAddress
  
  the #NMIPAddress to compare address to.
Returns boolean

get_address

get_address(): string

- Defined in @types/Gjs/NM-1.0.d.ts:28049
Gets the IP address property of this address object.

Returns string

get_attribute

get_attribute(name: string): GLib.Variant

- Defined in @types/Gjs/NM-1.0.d.ts:28054
Gets the value of the attribute with name name on address

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

get_attribute_names

get_attribute_names(): string[]

- Defined in @types/Gjs/NM-1.0.d.ts:28058
Gets an array of attribute names defined on address.

Returns string[]

get_family

get_family(): number

- Defined in @types/Gjs/NM-1.0.d.ts:28063
Gets the IP address family (eg, AF_INET) property of this address object.

Returns number

get_prefix

get_prefix(): number

- Defined in @types/Gjs/NM-1.0.d.ts:28068
Gets the IP address prefix (ie "24" or "30" etc) property of this address object.

Returns number

ref

ref(): void

- Defined in @types/Gjs/NM-1.0.d.ts:28072
Increases the reference count of the object.

Returns void

set_address

set_address(addr: string): void

- Defined in @types/Gjs/NM-1.0.d.ts:28080
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): void

- Defined in @types/Gjs/NM-1.0.d.ts:28086
Sets or clears the named attribute on address to the given value.

Parameters
- name: string
  
  the name of an address attribute
- value: GLib.Variant
  
  the value
Returns void

set_prefix

set_prefix(prefix: number): void

- Defined in @types/Gjs/NM-1.0.d.ts:28091
Sets the IP address prefix property of this address object.

Parameters
- prefix: number
  
  the IP address prefix
Returns void

unref

unref(): void

- Defined in @types/Gjs/NM-1.0.d.ts:28096
Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Returns void

Static new

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

- Defined in @types/Gjs/NM-1.0.d.ts:28122
Creates a new #NMIPAddress object.

Parameters
- family: number
  
  the IP address family (AF_INET or AF_INET6)
- addr: string
  
  the IP address
- prefix: number
  
  the address prefix length
Returns IPAddress

Static new_binary

new_binary(family: number, addr: object, prefix: number): IPAddress

- Defined in @types/Gjs/NM-1.0.d.ts:28131
Creates a new #NMIPAddress object. addr must point to a buffer of the correct size for family.

Parameters
- family: number
  
  the IP address family (AF_INET or AF_INET6)
- addr: object
  
  the IP address
- prefix: number
  
  the address prefix length
Returns IPAddress