API reference - Class QTcpServer

_const_cast

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

acceptError

Signature: [signal] void acceptError (const QAbstractSocket_SocketError socketError)

Description: Signal declaration for QTcpServer::acceptError(QAbstractSocket::SocketError socketError)

You can bind a procedure to this signal.

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

addPendingConnection

Signature: void addPendingConnection (QTcpSocket ptr socket)

Description: Method void QTcpServer::addPendingConnection(QTcpSocket *socket)

This method is protected and can only be called from inside a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QTcpServer::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

close

Signature: void close

Description: Method void QTcpServer::close()

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QTcpServer::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QTcpServer::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.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QTcpServer::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_acceptError

Signature: void emit_acceptError (const QAbstractSocket_SocketError socketError)

Description: Emitter for signal void QTcpServer::acceptError(QAbstractSocket::SocketError socketError)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QTcpServer::destroyed(QObject *)

Call this method to emit this signal.

emit_newConnection

Signature: void emit_newConnection

Description: Emitter for signal void QTcpServer::newConnection()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QTcpServer::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

errorString

Signature: [const] string errorString

Description: Method QString QTcpServer::errorString()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QTcpServer::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QTcpServer::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

hasPendingConnections

Signature: [const] bool hasPendingConnections

Description: Virtual method bool QTcpServer::hasPendingConnections()

This method can be reimplemented in a derived class.

incomingConnection

Signature: void incomingConnection (long long handle)

Description: Virtual method void QTcpServer::incomingConnection(QIntegerForSizeof<void*>::Signed handle)

This method can be reimplemented in a derived class.

isListening?

Signature: [const] bool isListening?

Description: Method bool QTcpServer::isListening()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QTcpServer::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

listen

Signature: bool listen (const QHostAddress address = QHostAddress::Any, unsigned short port = 0)

Description: Method bool QTcpServer::listen(const QHostAddress &address, quint16 port)

maxPendingConnections

Signature: [const] int maxPendingConnections

Description: Method int QTcpServer::maxPendingConnections()

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

maxPendingConnections=

Signature: void maxPendingConnections= (int numConnections)

Description: Method void QTcpServer::setMaxPendingConnections(int numConnections)

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

new

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

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

This method creates an object of class QTcpServer.

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

newConnection

Signature: [signal] void newConnection

Description: Signal declaration for QTcpServer::newConnection()

You can bind a procedure to this signal.

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

nextPendingConnection

Signature: QTcpSocket ptr nextPendingConnection

Description: Virtual method QTcpSocket *QTcpServer::nextPendingConnection()

This method can be reimplemented in a derived class.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QTcpServer::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.

pauseAccepting

Signature: void pauseAccepting

Description: Method void QTcpServer::pauseAccepting()

proxy

Signature: [const] QNetworkProxy proxy

Description: Method QNetworkProxy QTcpServer::proxy()

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

proxy=

Signature: void proxy= (const QNetworkProxy networkProxy)

Description: Method void QTcpServer::setProxy(const QNetworkProxy &networkProxy)

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QTcpServer::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

resumeAccepting

Signature: void resumeAccepting

Description: Method void QTcpServer::resumeAccepting()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QTcpServer::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QTcpServer::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

serverAddress

Signature: [const] QHostAddress serverAddress

Description: Method QHostAddress QTcpServer::serverAddress()

serverError

Signature: [const] QAbstractSocket_SocketError serverError

Description: Method QAbstractSocket::SocketError QTcpServer::serverError()

serverPort

Signature: [const] unsigned short serverPort

Description: Method quint16 QTcpServer::serverPort()

setMaxPendingConnections

Signature: void setMaxPendingConnections (int numConnections)

Description: Method void QTcpServer::setMaxPendingConnections(int numConnections)

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

setProxy

Signature: void setProxy (const QNetworkProxy networkProxy)

Description: Method void QTcpServer::setProxy(const QNetworkProxy &networkProxy)

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

setSocketDescriptor

Signature: bool setSocketDescriptor (long long socketDescriptor)

Description: Method bool QTcpServer::setSocketDescriptor(QIntegerForSizeof<void*>::Signed socketDescriptor)

socketDescriptor

Signature: [const] long long socketDescriptor

Description: Method QIntegerForSizeof<void*>::Signed QTcpServer::socketDescriptor()

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QTcpServer::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

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

Description: Static method QString QTcpServer::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 QTcpServer::trUtf8(const char *s, const char *c, int n)

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

waitForNewConnection

Signature: bool waitForNewConnection (int msec = 0, bool ptr timedOut = nullptr)

Description: Method bool QTcpServer::waitForNewConnection(int msec, bool *timedOut)