QNetworkInterface¶
Synopsis¶
Functions¶
| def addressEntries () |
| def flags () |
| def hardwareAddress () |
| def humanReadableName () |
| def index () |
| def isValid () |
| def name () |
| def operator= (other) |
Static functions¶
| def allAddresses () |
| def allInterfaces () |
| def interfaceFromIndex (index) |
| def interfaceFromName (name) |
Detailed Description¶
The QNetworkInterface class provides a listing of the host’s IP addresses and network interfaces.
QNetworkInterface represents one network interface attached to the host where the program is being run. Each network interface may contain zero or more IP addresses, each of which is optionally associated with a netmask and/or a broadcast address. The list of such trios can be obtained with QNetworkInterface.addressEntries() . Alternatively, when the netmask or the broadcast addresses aren’t necessary, use the QNetworkInterface.allAddresses() convenience function to obtain just the IP addresses.
QNetworkInterface also reports the interface’s hardware address with QNetworkInterface.hardwareAddress() .
Not all operating systems support reporting all features. Only the IPv4 addresses are guaranteed to be listed by this class in all platforms. In particular, IPv6 address listing is only supported on Windows XP and more recent versions, Linux, MacOS X and the BSDs.
See also
- class PySide.QtNetwork.QNetworkInterface¶
- class PySide.QtNetwork.QNetworkInterface(other)
Parameter: other – QNetworkInterface Constructs an empty network interface object.
Creates a copy of the QNetworkInterface object contained in other .
- QNetworkInterface.InterfaceFlag¶
Specifies the flags associated with this network interface. The possible values are:
Constant Description QNetworkInterface.IsUp the network interface is active QNetworkInterface.IsRunning the network interface has resources allocated QNetworkInterface.CanBroadcast the network interface works in broadcast mode QNetworkInterface.IsLoopBack the network interface is a loopback interface: that is, it’s a virtual interface whose destination is the host computer itself QNetworkInterface.IsPointToPoint the network interface is a point-to-point interface: that is, there is one, single other address that can be directly reached by it. QNetworkInterface.CanMulticast the network interface supports multicasting Note that one network interface cannot be both broadcast-based and point-to-point.
- QNetworkInterface.addressEntries()¶
Return type: List of QNetworkAddressEntry Returns the list of IP addresses that this interface possesses along with their associated netmasks and broadcast addresses.
If the netmask or broadcast address information is not necessary, you can call the QNetworkInterface.allAddresses() function to obtain just the IP addresses.
- static QNetworkInterface.allAddresses()¶
Return type: List of QHostAddress This convenience function returns all IP addresses found on the host machine. It is equivalent to calling QNetworkInterface.addressEntries() on all the objects returned by QNetworkInterface.allInterfaces() to obtain lists of QHostAddress objects then calling QHostAddress::ip() on each of these.
- static QNetworkInterface.allInterfaces()¶
Return type: List of QNetworkInterface Returns a listing of all the network interfaces found on the host machine.
- QNetworkInterface.flags()¶
Return type: InterfaceFlags Returns the flags associated with this network interface.
- QNetworkInterface.hardwareAddress()¶
Return type: QString Returns the low-level hardware address for this interface. On Ethernet interfaces, this will be a MAC address in string representation, separated by colons.
Other interface types may have other types of hardware addresses. Implementations should not depend on this function returning a valid MAC address.
- QNetworkInterface.humanReadableName()¶
Return type: QString Returns the human-readable name of this network interface on Windows, such as “Local Area Connection”, if the name could be determined. If it couldn’t, this function returns the same as QNetworkInterface.name() . The human-readable name is a name that the user can modify in the Windows Control Panel, so it may change during the execution of the program.
On Unix, this function currently always returns the same as QNetworkInterface.name() , since Unix systems don’t store a configuration for human-readable names.
- QNetworkInterface.index()¶
Return type: int Returns the interface system index, if known. This is an integer assigned by the operating system to identify this interface and it generally doesn’t change. It matches the scope ID field in IPv6 addresses.
If the index isn’t known, this function returns 0.
- static QNetworkInterface.interfaceFromIndex(index)¶
Parameter: index – int Return type: QNetworkInterface Returns a QNetworkInterface object for the interface whose internal ID is index . Network interfaces have a unique identifier called the “interface index” to distinguish it from other interfaces on the system. Often, this value is assigned progressively and interfaces being removed and then added again get a different value every time.
This index is also found in the IPv6 address’ scope ID field.
- static QNetworkInterface.interfaceFromName(name)¶
Parameter: name – QString Return type: QNetworkInterface Returns a QNetworkInterface object for the interface named name . If no such interface exists, this function returns an invalid QNetworkInterface object.
- QNetworkInterface.isValid()¶
Return type: bool Returns true if this QNetworkInterface object contains valid information about a network interface.
- QNetworkInterface.name()¶
Return type: QString Returns the name of this network interface. On Unix systems, this is a string containing the type of the interface and optionally a sequence number, such as “eth0”, “lo” or “pcn0”. On Windows, it’s an internal ID that cannot be changed by the user.
- QNetworkInterface.operator=(other)
Parameter: other – QNetworkInterface Return type: QNetworkInterface Copies the contents of the QNetworkInterface object contained in other into this one.
