API reference - Class QNetworkDatagram

_assign

Signature: void _assign (const QNetworkDatagram other)

Description: Assigns another object to self

_const_cast

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

Signature: QNetworkDatagram assign (const QNetworkDatagram other)

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

clear

Signature: void clear

Description: Method void QNetworkDatagram::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.

data

Signature: [const] bytes data

Description: Method QByteArray QNetworkDatagram::data()

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

data=

Signature: void data= (bytes data)

Description: Method void QNetworkDatagram::setData(const QByteArray &data)

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

destinationAddress

Signature: [const] QHostAddress destinationAddress

Description: Method QHostAddress QNetworkDatagram::destinationAddress()

destinationPort

Signature: [const] int destinationPort

Description: Method int QNetworkDatagram::destinationPort()

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

Description: Creates a copy of self

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

hopLimit

Signature: [const] int hopLimit

Description: Method int QNetworkDatagram::hopLimit()

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

hopLimit=

Signature: void hopLimit= (int count)

Description: Method void QNetworkDatagram::setHopLimit(int count)

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

interfaceIndex

Signature: [const] unsigned int interfaceIndex

Description: Method unsigned int QNetworkDatagram::interfaceIndex()

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

interfaceIndex=

Signature: void interfaceIndex= (unsigned int index)

Description: Method void QNetworkDatagram::setInterfaceIndex(unsigned int index)

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

isNull?

Signature: [const] bool isNull?

Description: Method bool QNetworkDatagram::isNull()

isValid?

Signature: [const] bool isValid?

Description: Method bool QNetworkDatagram::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.

makeReply

Signature: [const] QNetworkDatagram makeReply (bytes payload)

Description: Method QNetworkDatagram QNetworkDatagram::makeReply(const QByteArray &payload)

new

(1) Signature: [static] new QNetworkDatagram new

Description: Constructor QNetworkDatagram::QNetworkDatagram()

This method creates an object of class QNetworkDatagram.

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

(2) Signature: [static] new QNetworkDatagram new (bytes data, const QHostAddress destinationAddress = QHostAddress(), unsigned short port = 0)

Description: Constructor QNetworkDatagram::QNetworkDatagram(const QByteArray &data, const QHostAddress &destinationAddress, quint16 port)

This method creates an object of class QNetworkDatagram.

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

(3) Signature: [static] new QNetworkDatagram new (const QNetworkDatagram other)

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

This method creates an object of class QNetworkDatagram.

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

senderAddress

Signature: [const] QHostAddress senderAddress

Description: Method QHostAddress QNetworkDatagram::senderAddress()

senderPort

Signature: [const] int senderPort

Description: Method int QNetworkDatagram::senderPort()

setData

Signature: void setData (bytes data)

Description: Method void QNetworkDatagram::setData(const QByteArray &data)

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

setDestination

Signature: void setDestination (const QHostAddress address, unsigned short port)

Description: Method void QNetworkDatagram::setDestination(const QHostAddress &address, quint16 port)

setHopLimit

Signature: void setHopLimit (int count)

Description: Method void QNetworkDatagram::setHopLimit(int count)

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

setInterfaceIndex

Signature: void setInterfaceIndex (unsigned int index)

Description: Method void QNetworkDatagram::setInterfaceIndex(unsigned int index)

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

setSender

Signature: void setSender (const QHostAddress address, unsigned short port = 0)

Description: Method void QNetworkDatagram::setSender(const QHostAddress &address, quint16 port)

swap

Signature: void swap (QNetworkDatagram other)

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