DNSName objects

class DNSName

A DNSName object represents a name in the DNS. It is returned by several functions and has several functions to programmatically interact with it.

Creating a DNSName is done with the newDNSName():

myname = newDNSName("www.example.com")

dnsdist will complain loudly if the name is invalid (e.g. too long, dot in the wrong place).

The myname variable has several functions to get information from it

print(myname:countLabels()) -- prints "3"
print(myname:wirelength()) -- prints "17"
name2 = newDNSName("example.com")
if myname:isPartOf(name2) then -- prints "it is"
  print('it is')
end

Functions and methods of a DNSName

newDNSName(name) → DNSName

Returns the DNSName object of name.

Parameters:name (string) – The name to create a DNSName for
DNSName::chopoff() -> bool

New in version 1.2.0.

Removes the left-most label and returns true. false is returned if no label was removed

classmethod DNSName:countLabels() → int

Returns the number of DNSLabels in the name

classmethod DNSName:isPartOf(name) → bool

Returns true if the DNSName is part of the DNS tree of name.

Parameters:name (DNSName) – The name to check against
classmethod DNSName:toString() → string
classmethod DNSName:tostring() → string

Returns a human-readable form of the DNSName.

DNSName:wirelength -> int

Returns the length in bytes of the DNSName as it would be on the wire.