API reference - Class QHostInfo

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QHostInfo

Sub-classes: HostInfoError, QFlags_HostInfoError

Public constructors

new QHostInfonew(int lookupId = -1)Constructor QHostInfo::QHostInfo(int lookupId)
new QHostInfonew(const QHostInfo d)Constructor QHostInfo::QHostInfo(const QHostInfo &d)

Public methods

void_assign(const QHostInfo other)Assigns another object to self
[const]QHostInfo ptr_const_castReturns a non-const reference 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]QHostAddress[]addressesMethod QList<QHostAddress> QHostInfo::addresses()
voidaddresses=(QHostAddress[] addresses)Method void QHostInfo::setAddresses(const QList<QHostAddress> &addresses)
QHostInfoassign(const QHostInfo d)Method QHostInfo &QHostInfo::operator=(const QHostInfo &d)
[const]new QHostInfo ptrdupCreates a copy of self
[const]QHostInfo_HostInfoErrorerrorMethod QHostInfo::HostInfoError QHostInfo::error()
voiderror=(const QHostInfo_HostInfoError error)Method void QHostInfo::setError(QHostInfo::HostInfoError error)
[const]stringerrorStringMethod QString QHostInfo::errorString()
voiderrorString=(string errorString)Method void QHostInfo::setErrorString(const QString &errorString)
[const]stringhostNameMethod QString QHostInfo::hostName()
voidhostName=(string name)Method void QHostInfo::setHostName(const QString &name)
[const]intlookupIdMethod int QHostInfo::lookupId()
voidlookupId=(int id)Method void QHostInfo::setLookupId(int id)
voidsetAddresses(QHostAddress[] addresses)Method void QHostInfo::setAddresses(const QList<QHostAddress> &addresses)
voidsetError(const QHostInfo_HostInfoError error)Method void QHostInfo::setError(QHostInfo::HostInfoError error)
voidsetErrorString(string errorString)Method void QHostInfo::setErrorString(const QString &errorString)
voidsetHostName(string name)Method void QHostInfo::setHostName(const QString &name)
voidsetLookupId(int id)Method void QHostInfo::setLookupId(int id)
voidswap(QHostInfo other)Method void QHostInfo::swap(QHostInfo &other)

Public static methods and constants

[static,const]QHostInfo_HostInfoErrorHostNotFoundEnum constant QHostInfo::HostNotFound
[static,const]QHostInfo_HostInfoErrorNoErrorEnum constant QHostInfo::NoError
[static,const]QHostInfo_HostInfoErrorUnknownErrorEnum constant QHostInfo::UnknownError
voidabortHostLookup(int lookupId)Static method void QHostInfo::abortHostLookup(int lookupId)
QHostInfofromName(string name)Static method QHostInfo QHostInfo::fromName(const QString &name)
stringlocalDomainNameStatic method QString QHostInfo::localDomainName()
stringlocalHostNameStatic method QString QHostInfo::localHostName()
intlookupHost(string name,
QObject ptr receiver,
string member)
Static method int QHostInfo::lookupHost(const QString &name, QObject *receiver, const char *member)

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

HostNotFound

Signature: [static,const] QHostInfo_HostInfoError HostNotFound

Description: Enum constant QHostInfo::HostNotFound

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

NoError

Signature: [static,const] QHostInfo_HostInfoError NoError

Description: Enum constant QHostInfo::NoError

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

UnknownError

Signature: [static,const] QHostInfo_HostInfoError UnknownError

Description: Enum constant QHostInfo::UnknownError

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

_assign

Signature: void _assign (const QHostInfo other)

Description: Assigns another object to self

_const_cast

Signature: [const] QHostInfo ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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.

abortHostLookup

Signature: [static] void abortHostLookup (int lookupId)

Description: Static method void QHostInfo::abortHostLookup(int lookupId)

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

addresses

Signature: [const] QHostAddress[] addresses

Description: Method QList<QHostAddress> QHostInfo::addresses()

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

addresses=

Signature: void addresses= (QHostAddress[] addresses)

Description: Method void QHostInfo::setAddresses(const QList<QHostAddress> &addresses)

Python specific notes:
The object exposes a writable attribute 'addresses'. This is the setter.

assign

Signature: QHostInfo assign (const QHostInfo d)

Description: Method QHostInfo &QHostInfo::operator=(const QHostInfo &d)

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 QHostInfo ptr dup

Description: Creates a copy of self

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

error

Signature: [const] QHostInfo_HostInfoError error

Description: Method QHostInfo::HostInfoError QHostInfo::error()

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

error=

Signature: void error= (const QHostInfo_HostInfoError error)

Description: Method void QHostInfo::setError(QHostInfo::HostInfoError error)

Python specific notes:
The object exposes a writable attribute 'error'. This is the setter.

errorString

Signature: [const] string errorString

Description: Method QString QHostInfo::errorString()

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

errorString=

Signature: void errorString= (string errorString)

Description: Method void QHostInfo::setErrorString(const QString &errorString)

Python specific notes:
The object exposes a writable attribute 'errorString'. This is the setter.

fromName

Signature: [static] QHostInfo fromName (string name)

Description: Static method QHostInfo QHostInfo::fromName(const QString &name)

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

hostName

Signature: [const] string hostName

Description: Method QString QHostInfo::hostName()

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

hostName=

Signature: void hostName= (string name)

Description: Method void QHostInfo::setHostName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'hostName'. This is the setter.

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.

localDomainName

Signature: [static] string localDomainName

Description: Static method QString QHostInfo::localDomainName()

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

localHostName

Signature: [static] string localHostName

Description: Static method QString QHostInfo::localHostName()

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

lookupHost

Signature: [static] int lookupHost (string name, QObject ptr receiver, string member)

Description: Static method int QHostInfo::lookupHost(const QString &name, QObject *receiver, const char *member)

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

lookupId

Signature: [const] int lookupId

Description: Method int QHostInfo::lookupId()

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

lookupId=

Signature: void lookupId= (int id)

Description: Method void QHostInfo::setLookupId(int id)

Python specific notes:
The object exposes a writable attribute 'lookupId'. This is the setter.

new

(1) Signature: [static] new QHostInfo new (int lookupId = -1)

Description: Constructor QHostInfo::QHostInfo(int lookupId)

This method creates an object of class QHostInfo.

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

(2) Signature: [static] new QHostInfo new (const QHostInfo d)

Description: Constructor QHostInfo::QHostInfo(const QHostInfo &d)

This method creates an object of class QHostInfo.

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

setAddresses

Signature: void setAddresses (QHostAddress[] addresses)

Description: Method void QHostInfo::setAddresses(const QList<QHostAddress> &addresses)

Python specific notes:
The object exposes a writable attribute 'addresses'. This is the setter.

setError

Signature: void setError (const QHostInfo_HostInfoError error)

Description: Method void QHostInfo::setError(QHostInfo::HostInfoError error)

Python specific notes:
The object exposes a writable attribute 'error'. This is the setter.

setErrorString

Signature: void setErrorString (string errorString)

Description: Method void QHostInfo::setErrorString(const QString &errorString)

Python specific notes:
The object exposes a writable attribute 'errorString'. This is the setter.

setHostName

Signature: void setHostName (string name)

Description: Method void QHostInfo::setHostName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'hostName'. This is the setter.

setLookupId

Signature: void setLookupId (int id)

Description: Method void QHostInfo::setLookupId(int id)

Python specific notes:
The object exposes a writable attribute 'lookupId'. This is the setter.

swap

Signature: void swap (QHostInfo other)

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