KLayout Manual: Main Index » Class Index » API reference - Class QUdpSocket

API reference - Class QUdpSocket

Notation used in Ruby API documentation

Description: Binding of QUdpSocket

Class hierarchy: QUdpSocket » QAbstractSocket » QIODevice » QObject

Sub-classes: BindFlag

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

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

Detailed description

[static,const] new QUdpSocket_BindFlag ptr DefaultForPlatform

Description: Enum constant QUdpSocket::DefaultForPlatform

[static,const] new QUdpSocket_BindFlag ptr DontShareAddress

Description: Enum constant QUdpSocket::DontShareAddress

[static,const] new QUdpSocket_BindFlag ptr ReuseAddressHint

Description: Enum constant QUdpSocket::ReuseAddressHint

[static,const] new QUdpSocket_BindFlag ptr ShareAddress

Description: Enum constant QUdpSocket::ShareAddress

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.

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.

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

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

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.

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.

[event] void aboutToClose

Description: Signal declaration for QUdpSocket::aboutToClose()

You can bind a procedure to this signal.

bool bind(const QHostAddress address,unsigned short port)

Description: Method bool QUdpSocket::bind(const QHostAddress &address, quint16 port)

bool bind(unsigned short port = 0)

Description: Method bool QUdpSocket::bind(quint16 port)

bool bind(const QHostAddress address,unsigned short port,const QUdpSocket_QFlags_BindFlag mode)

Description: Method bool QUdpSocket::bind(const QHostAddress &address, quint16 port, QFlags<QUdpSocket::BindFlag> mode)

bool bind(unsigned short port,const QUdpSocket_QFlags_BindFlag mode)

Description: Method bool QUdpSocket::bind(quint16 port, QFlags<QUdpSocket::BindFlag> mode)

[event] void bytesWritten(long long bytes)

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

You can bind a procedure to this signal.

[event] void connected

Description: Signal declaration for QUdpSocket::connected()

You can bind a procedure to this signal.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[event] void disconnected

Description: Signal declaration for QUdpSocket::disconnected()

You can bind a procedure to this signal.

[event] void error(const QAbstractSocket_SocketError arg1)

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

You can bind a procedure to this signal.

[const] bool hasPendingDatagrams

Description: Method bool QUdpSocket::hasPendingDatagrams()

[event] void hostFound

Description: Signal declaration for QUdpSocket::hostFound()

You can bind a procedure to this signal.

[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

[static] new QUdpSocket new(QObject ptr parent = 0)

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

[const] long long pendingDatagramSize

Description: Method qint64 QUdpSocket::pendingDatagramSize()

[event] 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.

[event] void readChannelFinished

Description: Signal declaration for QUdpSocket::readChannelFinished()

You can bind a procedure to this signal.

[event] void readyRead

Description: Signal declaration for QUdpSocket::readyRead()

You can bind a procedure to this signal.

[event] void stateChanged(const QAbstractSocket_SocketState arg1)

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

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.

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)

long long writeDatagram(string datagram,const QHostAddress host,unsigned short port)

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