QHostAddress¶

PyQt5.QtNetwork.QHostAddress

Description¶

The QHostAddress class provides an IP address.

This class holds an IPv4 or IPv6 address in a platform- and protocol-independent manner.

QHostAddress is normally used with the QTcpSocket, QTcpServer, and QUdpSocket to connect to a host or to set up a server.

A host address is set with setAddress(), and retrieved with toIPv4Address(), toIPv6Address(), or toString(). You can check the type with protocol().

Note: Please note that QHostAddress does not do DNS lookups. QHostInfo is needed for that.

The class also supports common predefined addresses: Null, LocalHost, LocalHostIPv6, Broadcast, and Any.

Classes¶

ConversionMode

Enums¶

ConversionModeFlag

TODO

Member	Value	Description
ConvertLocalHost	TODO	TODO
ConvertUnspecifiedAddress	TODO	TODO
ConvertV4CompatToIPv4	TODO	TODO
ConvertV4MappedToIPv4	TODO	TODO
StrictConversion	TODO	TODO
TolerantConversion	TODO	TODO

SpecialAddress

Member	Value	Description
Any	4	The dual stack any-address. A socket bound with this address will listen on both IPv4 and IPv6 interfaces.
AnyIPv4	TODO	The IPv4 any-address. Equivalent to QHostAddress(“0.0.0.0”). A socket bound with this address will listen only on IPv4 interaces.
AnyIPv6	5	The IPv6 any-address. Equivalent to QHostAddress(“::”). A socket bound with this address will listen only on IPv6 interaces.
Broadcast	1	The IPv4 broadcast address. Equivalent to QHostAddress(“255.255.255.255”).
LocalHost	2	The IPv4 localhost address. Equivalent to QHostAddress(“127.0.0.1”).
LocalHostIPv6	3	The IPv6 localhost address. Equivalent to QHostAddress(“::1”).
Null	0	The null address object. Equivalent to QHostAddress. See also QHostAddress::isNull().

Methods¶

__init__(): Constructs a null host address object, i.e. an address which is not valid for any host or interface.

See also

clear().

__init__(SpecialAddress): Constructs a QHostAddress object for address.

__init__(int): Constructs a host address object with the IPv4 address ip4Addr.

__init__(str): Constructs an IPv4 or IPv6 address based on the string address (e.g., “127.0.0.1”).

See also

setAddress().

__init__(Tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int]): Constructs a host address object with the IPv6 address ip6Addr.

__init__(Union[QHostAddress, SpecialAddress]): Constructs a copy of the given address.

clear(): Sets the host address to null.

See also

Null.

__eq__(Union[QHostAddress, SpecialAddress]) → bool: TODO

__eq__(SpecialAddress) → bool: TODO

__hash__() → int: TODO

isBroadcast() → bool: TODO

isEqual(Union[QHostAddress, SpecialAddress], mode: Union[ConversionMode, ConversionModeFlag] = TolerantConversion) → bool: TODO

isGlobal() → bool: TODO

isInSubnet(Tuple[Union[QHostAddress, SpecialAddress], int]) → bool

This is an overloaded function.

Returns true if this IP is in the subnet described by subnet. The QHostAddress member of subnet contains the network prefix and the int (second) member contains the netmask (prefix length).

isInSubnet(Union[QHostAddress, SpecialAddress], int) → bool

Returns true if this IP is in the subnet described by the network prefix subnet and netmask netmask.

An IP is considered to belong to a subnet if it is contained between the lowest and the highest address in that subnet. In the case of IP version 4, the lowest address is the network address, while the highest address is the broadcast address.

The subnet argument does not have to be the actual network address (the lowest address in the subnet). It can be any valid IP belonging to that subnet. In particular, if it is equal to the IP address held by this object, this function will always return true (provided the netmask is a valid value).

See also

parseSubnet().

isLinkLocal() → bool: TODO

isLoopback() → bool: TODO

isMulticast() → bool: TODO

isNull() → bool

Returns true if this host address is not valid for any host or interface.

The default constructor creates a null address.

See also

Null.

isSiteLocal() → bool: TODO

isUniqueLocalUnicast() → bool: TODO

__ne__(Union[QHostAddress, SpecialAddress]) → bool: TODO

__ne__(SpecialAddress) → bool: TODO

@staticmethod parseSubnet(str) → Tuple[QHostAddress, int]

Parses the IP and subnet information contained in subnet and returns the network prefix for that network and its prefix length.

The IP address and the netmask must be separated by a slash (/).

This function supports arguments in the form:

123.123.123.123/n where n is any value between 0 and 32
123.123.123.123/255.255.255.255
<ipv6-address>/n where n is any value between 0 and 128

For IP version 4, this function accepts as well missing trailing components (i.e., less than 4 octets, like “192.168.1”), followed or not by a dot. If the netmask is also missing in that case, it is set to the number of octets actually passed (in the example above, it would be 24, for 3 octets).

See also

isInSubnet().

protocol() → NetworkLayerProtocol: Returns the network layer protocol of the host address.

scopeId() → str

Returns the scope ID of an IPv6 address. For IPv4 addresses, or if the address does not contain a scope ID, an empty QString is returned.

The IPv6 scope ID specifies the scope of reachability for non-global IPv6 addresses, limiting the area in which the address can be used. All IPv6 addresses are associated with such a reachability scope. The scope ID is used to disambiguate addresses that are not guaranteed to be globally unique.

IPv6 specifies the following four levels of reachability:

Node-local: Addresses that are only used for communicating with services on the same interface (e.g., the loopback interface “::1”).
Link-local: Addresses that are local to the network interface (link). There is always one link-local address for each IPv6 interface on your host. Link-local addresses (“fe80…”) are generated from the MAC address of the local network adaptor, and are not guaranteed to be unique.
Global: For globally routable addresses, such as public servers on the Internet.

When using a link-local or site-local address for IPv6 connections, you must specify the scope ID. The scope ID for a link-local address is usually the same as the interface name (e.g., “eth0”, “en1”) or number (e.g., “1”, “2”).

setAddress(SpecialAddress): TODO

setAddress(int): Set the IPv4 address specified by ip4Addr.

setAddress(str) → bool

This is an overloaded function.

Sets the IPv4 or IPv6 address specified by the string representation specified by address (e.g. “127.0.0.1”). Returns true and sets the address if the address was successfully parsed; otherwise returns false.

setAddress(Tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int])

This is an overloaded function.

Set the IPv6 address specified by ip6Addr.

setScopeId(str): Sets the IPv6 scope ID of the address to id. If the address protocol is not IPv6, this function does nothing. The scope ID may be set as an interface name (such as “eth0” or “en1”) or as an integer representing the interface index. If id is an interface name, QtNetwork will convert to an interface index using QNetworkInterface::interfaceIndexFromName() before calling the operating system networking functions.

See also

scopeId(), QNetworkInterface, interfaceFromName().

swap(QHostAddress): TODO

toIPv4Address() → int

Returns the IPv4 address as a number.

For example, if the address is 127.0.0.1, the returned value is 2130706433 (i.e. 0x7f000001).

This value is valid if the protocol() is IPv4Protocol, or if the protocol is IPv6Protocol, and the IPv6 address is an IPv4 mapped address. (RFC4291)

See also

toString().

toIPv6Address() → Tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int]

Returns the IPv6 address as a Q_IPV6ADDR structure. The structure consists of 16 unsigned characters.

# Q_IPV6ADDR addr = hostAddr.toIPv6Address();
# // addr contains 16 unsigned characters

# for (int i = 0; i < 16; ++i) {
#     // process addr[i]
# }

This value is valid if the protocol() is IPv6Protocol. If the protocol is IPv4Protocol, then the address is returned an an IPv4 mapped IPv6 address. (RFC4291)

See also

toString().

toString() → str

Returns the address as a string.

For example, if the address is the IPv4 address 127.0.0.1, the returned string is “127.0.0.1”. For IPv6 the string format will follow the RFC5952 recommendation. For Any, its IPv4 address will be returned (“0.0.0.0”)

See also

toIPv4Address().