Class IPAddress

Hierarchy

IPAddress

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

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

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

cmpFull

cmpFull(b: IPAddress, cmpFlags: IPAddressCmpFlags): number

- Defined in NM-1.0.d.ts:31669
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.
- cmpFlags: IPAddressCmpFlags
  
  the #NMIPAddressCmpFlags that indicate what to compare.
Returns number

dup

dup(): IPAddress

- Defined in NM-1.0.d.ts:31673
Creates a copy of address

Returns IPAddress

equal

equal(other: IPAddress): boolean

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

getAddress

getAddress(): string

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

Returns string

getAttribute

getAttribute(name: string): GLib.Variant

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

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

getAttributeNames

getAttributeNames(): string[]

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

Returns string[]

getFamily

getFamily(): number

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

Returns number

getPrefix

getPrefix(): number

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

Returns number

ref

ref(): void

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

Returns void

setAddress

setAddress(addr: string): void

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

setAttribute

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

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

setPrefix

setPrefix(prefix: number): void

- Defined in NM-1.0.d.ts:31725
Sets the IP address prefix property of this address object.

Parameters
- prefix: number
  
  the IP address prefix
Returns void

unref

unref(): void

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

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

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