QTcpServer Class

Dokumentation zu den Mitgliedsfunktionen

[explicit] QTcpServer::QTcpServer(QObject *parent = nullptr)

Erstellt ein QTcpServer-Objekt.

parent wird an den Konstruktor von ` QObject ` übergeben.

Siehe auch „ listen()“ und „ setSocketDescriptor()“.

[virtual noexcept] QTcpServer::~QTcpServer()

Löscht das Objekt „ QTcpServer “. Wenn der Server auf Verbindungen wartet, wird der Socket automatisch geschlossen.

Alle noch verbundenen Client- QTcpSockets müssen entweder die Verbindung trennen oder einem neuen Elternobjekt zugeordnet werden, bevor der Server gelöscht wird.

Siehe auch ` close()`.

[signal] void QTcpServer::acceptError(QAbstractSocket::SocketError socketError)

Dieses Signal wird ausgelöst, wenn beim Akzeptieren einer neuen Verbindung ein Fehler auftritt. Der Parameter „ socketError “ beschreibt die Art des aufgetretenen Fehlers.

Siehe auch „ pauseAccepting()“ und „ resumeAccepting()“.

[protected] void QTcpServer::addPendingConnection(QTcpSocket *socket)

Diese Funktion wird von ` QTcpServer::incomingConnection()` aufgerufen, um die ` socket ` zur Liste der ausstehenden eingehenden Verbindungen hinzuzufügen.

Siehe auch ` incomingConnection()` und ` pendingConnectionAvailable()`.

void QTcpServer::close()

Schließt den Server. Der Server wartet nicht mehr auf eingehende Verbindungen.

Siehe auch „ listen()“.

QString QTcpServer::errorString() const

Gibt eine für Menschen lesbare Beschreibung des zuletzt aufgetretenen Fehlers zurück.

Siehe auch ` serverError()`.

[virtual] bool QTcpServer::hasPendingConnections() const

Gibt „ true “ zurück, wenn der Server eine ausstehende Verbindung hat; andernfalls wird „ false “ zurückgegeben.

Siehe auch nextPendingConnection() und setMaxPendingConnections().

[virtual protected] void QTcpServer::incomingConnection(qintptr socketDescriptor)

Diese virtuelle Funktion wird von ` QTcpServer ` aufgerufen, wenn eine neue Verbindung verfügbar ist. Das Argument ` socketDescriptor ` ist der native Socket-Deskriptor für die akzeptierte Verbindung.

Die Basisimplementierung erstellt ein ` QTcpSocket`, legt den Socket-Deskriptor fest und speichert ` QTcpSocket ` anschließend in einer internen Liste ausstehender Verbindungen. Abschließend wird ` newConnection()` ausgelöst.

Implementieren Sie diese Funktion neu, um das Verhalten des Servers zu ändern, wenn eine Verbindung verfügbar ist.

Wenn dieser Server ` QNetworkProxy ` verwendet, ist der ` socketDescriptor ` möglicherweise nicht mit nativen Socket-Funktionen verwendbar und sollte ausschließlich mit ` QTcpSocket::setSocketDescriptor()` genutzt werden.

Siehe auch „ newConnection()“, „ nextPendingConnection()“ und „ addPendingConnection()“.

bool QTcpServer::isListening() const

Gibt „ true “ zurück, wenn der Server derzeit auf eingehende Verbindungen wartet; andernfalls wird „ false “ zurückgegeben.

Siehe auch listen().

bool QTcpServer::listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0)

Weist den Server an, auf eingehende Verbindungen unter der Adresse address und dem Port port zu warten. Ist port gleich 0, wird der Port automatisch ausgewählt. Ist address gleich QHostAddress::Any, wartet der Server auf allen Netzwerkschnittstellen.

Gibt bei Erfolg „ true “ zurück; andernfalls „ false “.

Siehe auch „ isListening()“.

[since 6.3] int QTcpServer::listenBacklogSize() const

Gibt die Größe der Backlog-Warteschlange der noch anzunehmenden Verbindungen zurück.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch ` setListenBacklogSize()`.

int QTcpServer::maxPendingConnections() const

Gibt die maximale Anzahl ausstehender akzeptierter Verbindungen zurück. Der Standardwert beträgt 30.

Siehe auch setMaxPendingConnections() und hasPendingConnections().

[signal] void QTcpServer::newConnection()

Dieses Signal wird jedes Mal ausgelöst, wenn eine neue Verbindung verfügbar ist, unabhängig davon, ob diese in die Warteschlange der ausstehenden Verbindungen aufgenommen wurde oder nicht.

Siehe auch hasPendingConnections() und nextPendingConnection().

[virtual] QTcpSocket *QTcpServer::nextPendingConnection()

Gibt die nächste ausstehende Verbindung als verbundenes „ QTcpSocket “-Objekt zurück.

Der Socket wird als untergeordnetes Element des Servers erstellt, was bedeutet, dass er automatisch gelöscht wird, wenn das ` QTcpServer `-Objekt zerstört wird. Es ist dennoch ratsam, das Objekt explizit zu löschen, wenn Sie es nicht mehr benötigen, um Speicherplatzverschwendung zu vermeiden.

nullptr wird zurückgegeben, wenn diese Funktion aufgerufen wird, während keine ausstehenden Verbindungen vorhanden sind.

Siehe auch ` hasPendingConnections()`.

void QTcpServer::pauseAccepting()

Die Annahme neuer Verbindungen wird unterbrochen. Verbindungen in der Warteschlange verbleiben dort.

Siehe auch resumeAccepting().

[private signal, since 6.4] void QTcpServer::pendingConnectionAvailable()

Dieses Signal wird jedes Mal ausgelöst, wenn eine neue Verbindung zur Warteschlange der ausstehenden Verbindungen hinzugefügt wurde.

Diese Funktion wurde in Qt 6.4 eingeführt.

Siehe auch „ hasPendingConnections()“ und „ nextPendingConnection()“.

QNetworkProxy QTcpServer::proxy() const

Gibt den Netzwerk-Proxy für diesen Socket zurück. Standardmäßig wird QNetworkProxy::DefaultProxy verwendet.

Siehe auch setProxy() und QNetworkProxy.

void QTcpServer::resumeAccepting()

Nimmt wieder neue Verbindungen an.

Siehe auch pauseAccepting().

QHostAddress QTcpServer::serverAddress() const

Gibt die Adresse des Servers zurück, sofern dieser auf Verbindungen wartet; andernfalls wird „ QHostAddress::Null “ zurückgegeben.

Siehe auch serverPort() und listen().

QAbstractSocket::SocketError QTcpServer::serverError() const

Gibt einen Fehlercode für den zuletzt aufgetretenen Fehler zurück.

Siehe auch „ errorString()“.

quint16 QTcpServer::serverPort() const

Gibt den Port des Servers zurück, wenn der Server auf Verbindungen wartet; andernfalls wird 0 zurückgegeben.

Siehe auch serverAddress() und listen().

[since 6.3] void QTcpServer::setListenBacklogSize(int size)

Legt die Größe der Backlog-Warteschlange für anzunehmende Verbindungen auf „ size “ fest. Das Betriebssystem kann diesen Wert möglicherweise reduzieren oder ignorieren. Standardmäßig beträgt die Warteschlangengröße 50.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch ` listenBacklogSize()`.

void QTcpServer::setMaxPendingConnections(int numConnections)

Legt die maximale Anzahl an ausstehenden akzeptierten Verbindungen auf „ numConnections “ fest. „ QTcpServer “ akzeptiert nicht mehr als „ numConnections “ eingehende Verbindungen, bevor „ nextPendingConnection()“ aufgerufen wird. Standardmäßig beträgt das Limit 30 ausstehende Verbindungen.

Clients können möglicherweise weiterhin eine Verbindung herstellen, nachdem der Server seine maximale Anzahl an ausstehenden Verbindungen erreicht hat (d. h., QTcpSocket kann weiterhin das Signal connected() ausgeben). QTcpServer akzeptiert keine neuen Verbindungen mehr, aber das Betriebssystem behält diese möglicherweise weiterhin in der Warteschlange.

Siehe auch ` maxPendingConnections()` und ` hasPendingConnections()`.

void QTcpServer::setProxy(const QNetworkProxy &networkProxy)

Legt den expliziten Netzwerk-Proxy für diesen Socket auf „ networkProxy “ fest.

Um die Verwendung eines Proxys für diesen Socket zu deaktivieren, verwenden Sie den Proxy-Typ „ QNetworkProxy::NoProxy “:

server->setProxy(QNetworkProxy::NoProxy);

Siehe auch proxy() und QNetworkProxy.

bool QTcpServer::setSocketDescriptor(qintptr socketDescriptor)

Legt den Socket-Deskriptor fest, den dieser Server beim Abhören auf eingehende Verbindungen zu socketDescriptor verwenden soll. Gibt „ true “ zurück, wenn der Socket erfolgreich eingerichtet wurde; andernfalls wird „ false “ zurückgegeben.

Es wird davon ausgegangen, dass sich der Socket im Listening-Zustand befindet.

Siehe auch socketDescriptor() und isListening().

qintptr QTcpServer::socketDescriptor() const

Gibt den nativen Socket-Deskriptor zurück, den der Server zum Abhören eingehender Befehle verwendet, oder -1, wenn der Server nicht im Abhörmodus ist.

Wenn der Server ` QNetworkProxy` verwendet, ist der zurückgegebene Deskriptor möglicherweise nicht mit nativen Socket-Funktionen verwendbar.

Siehe auch ` setSocketDescriptor()` und ` isListening()`.

bool QTcpServer::waitForNewConnection(int msec = 0, bool *timedOut = nullptr)

Wartet höchstens msec Millisekunden oder so lange, bis eine eingehende Verbindung verfügbar ist. Gibt „ true “ zurück, wenn eine Verbindung verfügbar ist; andernfalls wird „ false “ zurückgegeben. Wenn die Operation aufgrund einer Zeitüberschreitung abgebrochen wurde und „ timedOut “ nicht „ nullptr “ ist, wird *timedOut auf „true“ gesetzt.

Dies ist ein blockierender Funktionsaufruf. Von seiner Verwendung in einer Single-Thread-GUI-Anwendung wird abgeraten, da die gesamte Anwendung nicht mehr reagiert, bis die Funktion zurückkehrt. waitForNewConnection() ist vor allem dann nützlich, wenn keine Ereignisschleife verfügbar ist.

Die nicht blockierende Alternative besteht darin, sich an das Signal „ newConnection()“ anzuschließen.

Ist msec gleich -1, läuft diese Funktion ohne Zeitlimit ab.

Siehe auch ` hasPendingConnections()` und ` nextPendingConnection()`.