API reference - Class QHostAddress

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QHostAddress

Sub-classes: ConversionModeFlag, QFlags_ConversionModeFlag, SpecialAddress, QFlags_SpecialAddress

Public constructors

new QHostAddressnewConstructor QHostAddress::QHostAddress()
new QHostAddressnew(string address)Constructor QHostAddress::QHostAddress(const QString &address)
new QHostAddressnew(const QHostAddress copy)Constructor QHostAddress::QHostAddress(const QHostAddress &copy)

Public methods

[const]bool!=(const QHostAddress address)Method bool QHostAddress::operator !=(const QHostAddress &address)
[const]bool!=(const QHostAddress_SpecialAddress address)Method bool QHostAddress::operator !=(QHostAddress::SpecialAddress address)
[const]bool==(const QHostAddress address)Method bool QHostAddress::operator ==(const QHostAddress &address)
[const]bool==(const QHostAddress_SpecialAddress address)Method bool QHostAddress::operator ==(QHostAddress::SpecialAddress address)
void_assign(const QHostAddress other)Assigns another object to self
[const]QHostAddress 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.
QHostAddressassign(const QHostAddress other)Method QHostAddress &QHostAddress::operator=(const QHostAddress &other)
QHostAddressassign(string address)Method QHostAddress &QHostAddress::operator=(const QString &address)
QHostAddressassign(const QHostAddress_SpecialAddress address)Method QHostAddress &QHostAddress::operator=(QHostAddress::SpecialAddress address)
voidclearMethod void QHostAddress::clear()
[const]new QHostAddress ptrdupCreates a copy of self
[const]boolisBroadcast?Method bool QHostAddress::isBroadcast()
[const]boolisEqual?(const QHostAddress address,
QHostAddress_QFlags_ConversionModeFlag mode = QHostAddress::TolerantConversion)
Method bool QHostAddress::isEqual(const QHostAddress &address, QFlags<QHostAddress::ConversionModeFlag> mode)
[const]boolisGlobal?Method bool QHostAddress::isGlobal()
[const]boolisInSubnet?(const QHostAddress subnet,
int netmask)
Method bool QHostAddress::isInSubnet(const QHostAddress &subnet, int netmask)
[const]boolisInSubnet?(const QPair_QHostAddress_int subnet)Method bool QHostAddress::isInSubnet(const QPair<QHostAddress, int> &subnet)
[const]boolisLinkLocal?Method bool QHostAddress::isLinkLocal()
[const]boolisLoopback?Method bool QHostAddress::isLoopback()
[const]boolisMulticast?Method bool QHostAddress::isMulticast()
[const]boolisNull?Method bool QHostAddress::isNull()
[const]boolisSiteLocal?Method bool QHostAddress::isSiteLocal()
[const]boolisUniqueLocalUnicast?Method bool QHostAddress::isUniqueLocalUnicast()
[const]QAbstractSocket_NetworkLayerProtocolprotocolMethod QAbstractSocket::NetworkLayerProtocol QHostAddress::protocol()
[const]stringscopeIdMethod QString QHostAddress::scopeId()
voidscopeId=(string id)Method void QHostAddress::setScopeId(const QString &id)
voidsetAddress(unsigned int ip4Addr)Method void QHostAddress::setAddress(quint32 ip4Addr)
boolsetAddress(string address)Method bool QHostAddress::setAddress(const QString &address)
voidsetAddress(const QHostAddress_SpecialAddress address)Method void QHostAddress::setAddress(QHostAddress::SpecialAddress address)
voidsetScopeId(string id)Method void QHostAddress::setScopeId(const QString &id)
voidswap(QHostAddress other)Method void QHostAddress::swap(QHostAddress &other)
[const]unsigned inttoIPv4AddressMethod quint32 QHostAddress::toIPv4Address()
[const]unsigned inttoIPv4Address(bool ptr ok)Method quint32 QHostAddress::toIPv4Address(bool *ok)
[const]stringtoStringMethod QString QHostAddress::toString()
[const]stringto_sMethod QString QHostAddress::toString()

Public static methods and constants

[static,const]QHostAddress_SpecialAddressAnyEnum constant QHostAddress::Any
[static,const]QHostAddress_SpecialAddressAnyIPv4Enum constant QHostAddress::AnyIPv4
[static,const]QHostAddress_SpecialAddressAnyIPv6Enum constant QHostAddress::AnyIPv6
[static,const]QHostAddress_SpecialAddressBroadcastEnum constant QHostAddress::Broadcast
[static,const]QHostAddress_ConversionModeFlagConvertLocalHostEnum constant QHostAddress::ConvertLocalHost
[static,const]QHostAddress_ConversionModeFlagConvertUnspecifiedAddressEnum constant QHostAddress::ConvertUnspecifiedAddress
[static,const]QHostAddress_ConversionModeFlagConvertV4CompatToIPv4Enum constant QHostAddress::ConvertV4CompatToIPv4
[static,const]QHostAddress_ConversionModeFlagConvertV4MappedToIPv4Enum constant QHostAddress::ConvertV4MappedToIPv4
[static,const]QHostAddress_SpecialAddressLocalHostEnum constant QHostAddress::LocalHost
[static,const]QHostAddress_SpecialAddressLocalHostIPv6Enum constant QHostAddress::LocalHostIPv6
[static,const]QHostAddress_SpecialAddressNullEnum constant QHostAddress::Null
[static,const]QHostAddress_ConversionModeFlagStrictConversionEnum constant QHostAddress::StrictConversion
[static,const]QHostAddress_ConversionModeFlagTolerantConversionEnum constant QHostAddress::TolerantConversion
new QHostAddressnew_ip4(unsigned int ip4Addr)Constructor QHostAddress::QHostAddress(quint32 ip4Addr)
new QHostAddressnew_special(const QHostAddress_SpecialAddress address)Constructor QHostAddress::QHostAddress(QHostAddress::SpecialAddress address)
QPair_QHostAddress_intparseSubnet(string subnet)Static method QPair<QHostAddress, int> QHostAddress::parseSubnet(const QString &subnet)

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

!=

(1) Signature: [const] bool != (const QHostAddress address)

Description: Method bool QHostAddress::operator !=(const QHostAddress &address)

(2) Signature: [const] bool != (const QHostAddress_SpecialAddress address)

Description: Method bool QHostAddress::operator !=(QHostAddress::SpecialAddress address)

==

(1) Signature: [const] bool == (const QHostAddress address)

Description: Method bool QHostAddress::operator ==(const QHostAddress &address)

(2) Signature: [const] bool == (const QHostAddress_SpecialAddress address)

Description: Method bool QHostAddress::operator ==(QHostAddress::SpecialAddress address)

Any

Signature: [static,const] QHostAddress_SpecialAddress Any

Description: Enum constant QHostAddress::Any

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

AnyIPv4

Signature: [static,const] QHostAddress_SpecialAddress AnyIPv4

Description: Enum constant QHostAddress::AnyIPv4

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

AnyIPv6

Signature: [static,const] QHostAddress_SpecialAddress AnyIPv6

Description: Enum constant QHostAddress::AnyIPv6

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

Broadcast

Signature: [static,const] QHostAddress_SpecialAddress Broadcast

Description: Enum constant QHostAddress::Broadcast

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

ConvertLocalHost

Signature: [static,const] QHostAddress_ConversionModeFlag ConvertLocalHost

Description: Enum constant QHostAddress::ConvertLocalHost

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

ConvertUnspecifiedAddress

Signature: [static,const] QHostAddress_ConversionModeFlag ConvertUnspecifiedAddress

Description: Enum constant QHostAddress::ConvertUnspecifiedAddress

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

ConvertV4CompatToIPv4

Signature: [static,const] QHostAddress_ConversionModeFlag ConvertV4CompatToIPv4

Description: Enum constant QHostAddress::ConvertV4CompatToIPv4

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

ConvertV4MappedToIPv4

Signature: [static,const] QHostAddress_ConversionModeFlag ConvertV4MappedToIPv4

Description: Enum constant QHostAddress::ConvertV4MappedToIPv4

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

LocalHost

Signature: [static,const] QHostAddress_SpecialAddress LocalHost

Description: Enum constant QHostAddress::LocalHost

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

LocalHostIPv6

Signature: [static,const] QHostAddress_SpecialAddress LocalHostIPv6

Description: Enum constant QHostAddress::LocalHostIPv6

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

Null

Signature: [static,const] QHostAddress_SpecialAddress Null

Description: Enum constant QHostAddress::Null

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

StrictConversion

Signature: [static,const] QHostAddress_ConversionModeFlag StrictConversion

Description: Enum constant QHostAddress::StrictConversion

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

TolerantConversion

Signature: [static,const] QHostAddress_ConversionModeFlag TolerantConversion

Description: Enum constant QHostAddress::TolerantConversion

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

_assign

Signature: void _assign (const QHostAddress other)

Description: Assigns another object to self

_const_cast

Signature: [const] QHostAddress 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.

assign

(1) Signature: QHostAddress assign (const QHostAddress other)

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

(2) Signature: QHostAddress assign (string address)

Description: Method QHostAddress &QHostAddress::operator=(const QString &address)

(3) Signature: QHostAddress assign (const QHostAddress_SpecialAddress address)

Description: Method QHostAddress &QHostAddress::operator=(QHostAddress::SpecialAddress address)

clear

Signature: void clear

Description: Method void QHostAddress::clear()

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

Description: Creates a copy of self

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

isBroadcast?

Signature: [const] bool isBroadcast?

Description: Method bool QHostAddress::isBroadcast()

isEqual?

Signature: [const] bool isEqual? (const QHostAddress address, QHostAddress_QFlags_ConversionModeFlag mode = QHostAddress::TolerantConversion)

Description: Method bool QHostAddress::isEqual(const QHostAddress &address, QFlags<QHostAddress::ConversionModeFlag> mode)

isGlobal?

Signature: [const] bool isGlobal?

Description: Method bool QHostAddress::isGlobal()

isInSubnet?

(1) Signature: [const] bool isInSubnet? (const QHostAddress subnet, int netmask)

Description: Method bool QHostAddress::isInSubnet(const QHostAddress &subnet, int netmask)

(2) Signature: [const] bool isInSubnet? (const QPair_QHostAddress_int subnet)

Description: Method bool QHostAddress::isInSubnet(const QPair<QHostAddress, int> &subnet)

isLinkLocal?

Signature: [const] bool isLinkLocal?

Description: Method bool QHostAddress::isLinkLocal()

isLoopback?

Signature: [const] bool isLoopback?

Description: Method bool QHostAddress::isLoopback()

isMulticast?

Signature: [const] bool isMulticast?

Description: Method bool QHostAddress::isMulticast()

isNull?

Signature: [const] bool isNull?

Description: Method bool QHostAddress::isNull()

isSiteLocal?

Signature: [const] bool isSiteLocal?

Description: Method bool QHostAddress::isSiteLocal()

isUniqueLocalUnicast?

Signature: [const] bool isUniqueLocalUnicast?

Description: Method bool QHostAddress::isUniqueLocalUnicast()

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.

new

(1) Signature: [static] new QHostAddress new

Description: Constructor QHostAddress::QHostAddress()

This method creates an object of class QHostAddress.

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

(2) Signature: [static] new QHostAddress new (string address)

Description: Constructor QHostAddress::QHostAddress(const QString &address)

This method creates an object of class QHostAddress.

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

(3) Signature: [static] new QHostAddress new (const QHostAddress copy)

Description: Constructor QHostAddress::QHostAddress(const QHostAddress &copy)

This method creates an object of class QHostAddress.

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

new_ip4

Signature: [static] new QHostAddress new_ip4 (unsigned int ip4Addr)

Description: Constructor QHostAddress::QHostAddress(quint32 ip4Addr)

This method creates an object of class QHostAddress.

new_special

Signature: [static] new QHostAddress new_special (const QHostAddress_SpecialAddress address)

Description: Constructor QHostAddress::QHostAddress(QHostAddress::SpecialAddress address)

This method creates an object of class QHostAddress.

parseSubnet

Signature: [static] QPair_QHostAddress_int parseSubnet (string subnet)

Description: Static method QPair<QHostAddress, int> QHostAddress::parseSubnet(const QString &subnet)

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

protocol

Signature: [const] QAbstractSocket_NetworkLayerProtocol protocol

Description: Method QAbstractSocket::NetworkLayerProtocol QHostAddress::protocol()

scopeId

Signature: [const] string scopeId

Description: Method QString QHostAddress::scopeId()

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

scopeId=

Signature: void scopeId= (string id)

Description: Method void QHostAddress::setScopeId(const QString &id)

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

setAddress

(1) Signature: void setAddress (unsigned int ip4Addr)

Description: Method void QHostAddress::setAddress(quint32 ip4Addr)

(2) Signature: bool setAddress (string address)

Description: Method bool QHostAddress::setAddress(const QString &address)

(3) Signature: void setAddress (const QHostAddress_SpecialAddress address)

Description: Method void QHostAddress::setAddress(QHostAddress::SpecialAddress address)

setScopeId

Signature: void setScopeId (string id)

Description: Method void QHostAddress::setScopeId(const QString &id)

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

swap

Signature: void swap (QHostAddress other)

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

toIPv4Address

(1) Signature: [const] unsigned int toIPv4Address

Description: Method quint32 QHostAddress::toIPv4Address()

(2) Signature: [const] unsigned int toIPv4Address (bool ptr ok)

Description: Method quint32 QHostAddress::toIPv4Address(bool *ok)

toString

Signature: [const] string toString

Description: Method QString QHostAddress::toString()

Python specific notes:
This method is also available as 'str(object)'.

to_s

Signature: [const] string to_s

Description: Method QString QHostAddress::toString()

Python specific notes:
This method is also available as 'str(object)'.