API reference - Class QUdpSocket

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

aboutToClose

Signature: [signal] void aboutToClose

Description: Signal declaration for QUdpSocket::aboutToClose()

You can bind a procedure to this signal.

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

bytesWritten

Signature: [signal] void bytesWritten (long long bytes)

Description: Signal declaration for QUdpSocket::bytesWritten(qint64 bytes)

You can bind a procedure to this signal.

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

channelBytesWritten

Signature: [signal] void channelBytesWritten (int channel, long long bytes)

Description: Signal declaration for QUdpSocket::channelBytesWritten(int channel, qint64 bytes)

You can bind a procedure to this signal.

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

channelReadyRead

Signature: [signal] void channelReadyRead (int channel)

Description: Signal declaration for QUdpSocket::channelReadyRead(int channel)

You can bind a procedure to this signal.

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

connected

Signature: [signal] void connected

Description: Signal declaration for QUdpSocket::connected()

You can bind a procedure to this signal.

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

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QUdpSocket::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnected

Signature: [signal] void disconnected

Description: Signal declaration for QUdpSocket::disconnected()

You can bind a procedure to this signal.

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

error_sig

Signature: [signal] void error_sig (const QAbstractSocket_SocketError arg1)

Description: Signal declaration for QUdpSocket::error(QAbstractSocket::SocketError)

You can bind a procedure to this signal.

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

hasPendingDatagrams

Signature: [const] bool hasPendingDatagrams

Description: Method bool QUdpSocket::hasPendingDatagrams()

hostFound

Signature: [signal] void hostFound

Description: Signal declaration for QUdpSocket::hostFound()

You can bind a procedure to this signal.

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

joinMulticastGroup

(1) Signature: bool joinMulticastGroup (const QHostAddress groupAddress)

Description: Method bool QUdpSocket::joinMulticastGroup(const QHostAddress &groupAddress)

(2) Signature: bool joinMulticastGroup (const QHostAddress groupAddress, const QNetworkInterface iface)

Description: Method bool QUdpSocket::joinMulticastGroup(const QHostAddress &groupAddress, const QNetworkInterface &iface)

leaveMulticastGroup

(1) Signature: bool leaveMulticastGroup (const QHostAddress groupAddress)

Description: Method bool QUdpSocket::leaveMulticastGroup(const QHostAddress &groupAddress)

(2) Signature: bool leaveMulticastGroup (const QHostAddress groupAddress, const QNetworkInterface iface)

Description: Method bool QUdpSocket::leaveMulticastGroup(const QHostAddress &groupAddress, const QNetworkInterface &iface)

multicastInterface

Signature: [const] QNetworkInterface multicastInterface

Description: Method QNetworkInterface QUdpSocket::multicastInterface()

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

multicastInterface=

Signature: void multicastInterface= (const QNetworkInterface iface)

Description: Method void QUdpSocket::setMulticastInterface(const QNetworkInterface &iface)

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

new

Signature: [static] new QUdpSocket new (QObject ptr parent = nullptr)

Description: Constructor QUdpSocket::QUdpSocket(QObject *parent)

This method creates an object of class QUdpSocket.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QUdpSocket::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

pendingDatagramSize

Signature: [const] long long pendingDatagramSize

Description: Method qint64 QUdpSocket::pendingDatagramSize()

proxyAuthenticationRequired

Signature: [signal] void proxyAuthenticationRequired (const QNetworkProxy proxy, QAuthenticator ptr authenticator)

Description: Signal declaration for QUdpSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

You can bind a procedure to this signal.

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

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QUdpSocket::readChannelFinished()

You can bind a procedure to this signal.

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

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QUdpSocket::readyRead()

You can bind a procedure to this signal.

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

receiveDatagram

Signature: QNetworkDatagram receiveDatagram (long long maxSize = -1)

Description: Method QNetworkDatagram QUdpSocket::receiveDatagram(qint64 maxSize)

setMulticastInterface

Signature: void setMulticastInterface (const QNetworkInterface iface)

Description: Method void QUdpSocket::setMulticastInterface(const QNetworkInterface &iface)

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

stateChanged

Signature: [signal] void stateChanged (const QAbstractSocket_SocketState arg1)

Description: Signal declaration for QUdpSocket::stateChanged(QAbstractSocket::SocketState)

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QUdpSocket::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QUdpSocket::trUtf8(const char *s, const char *c, int n)

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

writeDatagram

(1) Signature: long long writeDatagram (const QNetworkDatagram datagram)

Description: Method qint64 QUdpSocket::writeDatagram(const QNetworkDatagram &datagram)

(2) Signature: long long writeDatagram (string data, long long len, const QHostAddress host, unsigned short port)

Description: Method qint64 QUdpSocket::writeDatagram(const char *data, qint64 len, const QHostAddress &host, quint16 port)

(3) Signature: long long writeDatagram (bytes datagram, const QHostAddress host, unsigned short port)

Description: Method qint64 QUdpSocket::writeDatagram(const QByteArray &datagram, const QHostAddress &host, quint16 port)