API reference - Class QNetworkInterface

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QNetworkInterface

Sub-classes: InterfaceFlag, QFlags_InterfaceFlag

Public constructors

new QNetworkInterfacenewConstructor QNetworkInterface::QNetworkInterface()
new QNetworkInterfacenew(const QNetworkInterface other)Constructor QNetworkInterface::QNetworkInterface(const QNetworkInterface &other)

Public methods

void_assign(const QNetworkInterface other)Assigns another object to self
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]QNetworkAddressEntry[]addressEntriesMethod QList<QNetworkAddressEntry> QNetworkInterface::addressEntries()
QNetworkInterfaceassign(const QNetworkInterface other)Method QNetworkInterface &QNetworkInterface::operator=(const QNetworkInterface &other)
[const]new QNetworkInterface ptrdupCreates a copy of self
[const]QNetworkInterface_QFlags_InterfaceFlagflagsMethod QFlags<QNetworkInterface::InterfaceFlag> QNetworkInterface::flags()
[const]stringhardwareAddressMethod QString QNetworkInterface::hardwareAddress()
[const]stringhumanReadableNameMethod QString QNetworkInterface::humanReadableName()
[const]intindexMethod int QNetworkInterface::index()
[const]boolisValid?Method bool QNetworkInterface::isValid()
[const]stringnameMethod QString QNetworkInterface::name()
voidswap(QNetworkInterface other)Method void QNetworkInterface::swap(QNetworkInterface &other)

Public static methods and constants

[static,const]QNetworkInterface_InterfaceFlagCanBroadcastEnum constant QNetworkInterface::CanBroadcast
[static,const]QNetworkInterface_InterfaceFlagCanMulticastEnum constant QNetworkInterface::CanMulticast
[static,const]QNetworkInterface_InterfaceFlagIsLoopBackEnum constant QNetworkInterface::IsLoopBack
[static,const]QNetworkInterface_InterfaceFlagIsPointToPointEnum constant QNetworkInterface::IsPointToPoint
[static,const]QNetworkInterface_InterfaceFlagIsRunningEnum constant QNetworkInterface::IsRunning
[static,const]QNetworkInterface_InterfaceFlagIsUpEnum constant QNetworkInterface::IsUp
QHostAddress[]allAddressesStatic method QList<QHostAddress> QNetworkInterface::allAddresses()
QNetworkInterface[]allInterfacesStatic method QList<QNetworkInterface> QNetworkInterface::allInterfaces()
QNetworkInterfaceinterfaceFromIndex(int index)Static method QNetworkInterface QNetworkInterface::interfaceFromIndex(int index)
QNetworkInterfaceinterfaceFromName(string name)Static method QNetworkInterface QNetworkInterface::interfaceFromName(const QString &name)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

CanBroadcast

Signature: [static,const] QNetworkInterface_InterfaceFlag CanBroadcast

Description: Enum constant QNetworkInterface::CanBroadcast

Python specific notes:
The object exposes a readable attribute 'CanBroadcast'. This is the getter.

CanMulticast

Signature: [static,const] QNetworkInterface_InterfaceFlag CanMulticast

Description: Enum constant QNetworkInterface::CanMulticast

Python specific notes:
The object exposes a readable attribute 'CanMulticast'. This is the getter.

IsLoopBack

Signature: [static,const] QNetworkInterface_InterfaceFlag IsLoopBack

Description: Enum constant QNetworkInterface::IsLoopBack

Python specific notes:
The object exposes a readable attribute 'IsLoopBack'. This is the getter.

IsPointToPoint

Signature: [static,const] QNetworkInterface_InterfaceFlag IsPointToPoint

Description: Enum constant QNetworkInterface::IsPointToPoint

Python specific notes:
The object exposes a readable attribute 'IsPointToPoint'. This is the getter.

IsRunning

Signature: [static,const] QNetworkInterface_InterfaceFlag IsRunning

Description: Enum constant QNetworkInterface::IsRunning

Python specific notes:
The object exposes a readable attribute 'IsRunning'. This is the getter.

IsUp

Signature: [static,const] QNetworkInterface_InterfaceFlag IsUp

Description: Enum constant QNetworkInterface::IsUp

Python specific notes:
The object exposes a readable attribute 'IsUp'. This is the getter.

_assign

Signature: void _assign (const QNetworkInterface other)

Description: Assigns another object to self

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

addressEntries

Signature: [const] QNetworkAddressEntry[] addressEntries

Description: Method QList<QNetworkAddressEntry> QNetworkInterface::addressEntries()

allAddresses

Signature: [static] QHostAddress[] allAddresses

Description: Static method QList<QHostAddress> QNetworkInterface::allAddresses()

This method is static and can be called without an instance.

allInterfaces

Signature: [static] QNetworkInterface[] allInterfaces

Description: Static method QList<QNetworkInterface> QNetworkInterface::allInterfaces()

This method is static and can be called without an instance.

assign

Signature: QNetworkInterface assign (const QNetworkInterface other)

Description: Method QNetworkInterface &QNetworkInterface::operator=(const QNetworkInterface &other)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QNetworkInterface ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

flags

Signature: [const] QNetworkInterface_QFlags_InterfaceFlag flags

Description: Method QFlags<QNetworkInterface::InterfaceFlag> QNetworkInterface::flags()

hardwareAddress

Signature: [const] string hardwareAddress

Description: Method QString QNetworkInterface::hardwareAddress()

humanReadableName

Signature: [const] string humanReadableName

Description: Method QString QNetworkInterface::humanReadableName()

index

Signature: [const] int index

Description: Method int QNetworkInterface::index()

interfaceFromIndex

Signature: [static] QNetworkInterface interfaceFromIndex (int index)

Description: Static method QNetworkInterface QNetworkInterface::interfaceFromIndex(int index)

This method is static and can be called without an instance.

interfaceFromName

Signature: [static] QNetworkInterface interfaceFromName (string name)

Description: Static method QNetworkInterface QNetworkInterface::interfaceFromName(const QString &name)

This method is static and can be called without an instance.

isValid?

Signature: [const] bool isValid?

Description: Method bool QNetworkInterface::isValid()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

name

Signature: [const] string name

Description: Method QString QNetworkInterface::name()

new

(1) Signature: [static] new QNetworkInterface new

Description: Constructor QNetworkInterface::QNetworkInterface()

This method creates an object of class QNetworkInterface.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QNetworkInterface new (const QNetworkInterface other)

Description: Constructor QNetworkInterface::QNetworkInterface(const QNetworkInterface &other)

This method creates an object of class QNetworkInterface.

Python specific notes:
This method is the default initializer of the object.

swap

Signature: void swap (QNetworkInterface other)

Description: Method void QNetworkInterface::swap(QNetworkInterface &other)