QAbstractHttpServer Class

Dokumentation der Mitgliedsfunktionen

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

Erzeugt eine Instanz von QAbstractHttpServer mit dem übergeordneten parent.

[override virtual noexcept] QAbstractHttpServer::~QAbstractHttpServer()

Zerstört eine Instanz von QAbstractHttpServer.

[since 6.8] template <typename Handler> void QAbstractHttpServer::addWebSocketUpgradeVerifier(const QObject *context, Handler &&func)

Fügt eine Callback-Funktion func hinzu, die eingehende WebSocket-Upgrades verifiziert. Sie wird über das bereitgestellte context Objekt aufgerufen. Ein Upgrade ist erfolgreich, wenn mindestens ein registrierter Callback Accept zurückgibt und kein vorheriger Callback Deny zurückgegeben hat. Wenn keine Rückrufe registriert sind oder alle PassToNext zurückgeben, wird die Funktion missingHandler() aufgerufen. Rückrufe werden in der Reihenfolge ausgeführt, in der sie registriert wurden, und sie können diese Funktion nicht selbst aufrufen.

server.addWebSocketUpgradeVerifier(
        &server, [](const QHttpServerRequest &request) {
            if (request.url().path() == "/allowed"_L1)
                return QHttpServerWebSocketUpgradeResponse::accept();
            else
                return QHttpServerWebSocketUpgradeResponse::passToNext();
        });

Diese Funktion wurde in Qt 6.8 eingeführt.

Siehe auch QHttpServerRequest, QHttpServerWebSocketUpgradeResponse, hasPendingWebSocketConnections(), nextPendingWebSocketConnection(), newWebSocketConnection(), und missingHandler().

bool QAbstractHttpServer::bind(QLocalServer *server)

Bindet das angegebene QLocalServer server , über das die Übertragung erfolgt, an den HTTP-Server. Es ist möglich, diese Funktion mehrere Male mit verschiedenen Instanzen von server aufzurufen, um mehrere Verbindungen zu behandeln.

Nach dem Aufruf dieser Funktion wird jede neue Verbindung vom HTTP-Server bearbeitet und weitergeleitet.

Es liegt in der Verantwortung des Benutzers, QLocalServer::listen() auf server aufzurufen, bevor diese Funktion aufgerufen wird. Wenn server nicht zuhört, passiert nichts und false wird zurückgegeben.

Wenn die server nullptr ist, wird false zurückgegeben.

Bei Erfolg wird server diesem HTTP-Server untergeordnet und true zurückgegeben.

Siehe auch QLocalServer und QLocalServer::listen().

bool QAbstractHttpServer::bind(QTcpServer *server)

Bindet den angegebenen TCP server, über den die Übertragung erfolgt, an den HTTP-Server. Es ist möglich, diese Funktion mehrfach mit verschiedenen Instanzen von TCP server aufzurufen, um mehrere Verbindungen und Ports zu behandeln, z.B. sowohl SSL- als auch nicht verschlüsselte Verbindungen.

Nach dem Aufruf dieser Funktion wird jede neue Verbindung vom HTTP-Server bearbeitet und weitergeleitet.

Es liegt in der Verantwortung des Benutzers, QTcpServer::listen() auf server aufzurufen, bevor diese Funktion aufgerufen wird. Wenn server nicht zuhört, passiert nichts und false wird zurückgegeben.

Bei Erfolg wird server diesem HTTP-Server übergeordnet und true wird zurückgegeben.

Um die Verwendung von HTTP 2 zu ermöglichen, binden Sie sich an einen QSslServer, bei dem QSslConfiguration::setAllowedNextProtocols() mit den Argumenten { QSslConfiguration::ALPNProtocolHTTP2 } aufgerufen wurde.

Siehe auch QTcpServer, QTcpServer::listen(), und QSslConfiguration::setAllowedNextProtocols().

[since 6.9] QHttpServerConfiguration QAbstractHttpServer::configuration() const

Gibt die allgemeinen Konfigurationsparameter des Servers zurück.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch setConfiguration().

[pure virtual protected] bool QAbstractHttpServer::handleRequest(const QHttpServerRequest &request, QHttpServerResponder &responder)

Überschreiben Sie diese Funktion, um jede eingehende request zu bearbeiten, indem Sie die request prüfen und die entsprechende Antwort an responder zurücksenden. Geben Sie true zurück, wenn die request erfolgreich bearbeitet wurde. Wenn diese Methode false zurückgibt, wird anschließend missingHandler() aufgerufen.

bool QAbstractHttpServer::hasPendingWebSocketConnections() const

Gibt true zurück, wenn der Server noch nicht abgeschlossene WebSocket-Verbindungen hat; andernfalls false.

Siehe auch newWebSocketConnection(), nextPendingWebSocketConnection(), und addWebSocketUpgradeVerifier().

[since 6.8] QHttp2Configuration QAbstractHttpServer::http2Configuration() const

Gibt die HTTP/2-Konfigurationsparameter des Servers zurück.

Diese Funktion wurde in Qt 6.8 eingeführt.

Siehe auch setHttp2Configuration().

QList<QLocalServer *> QAbstractHttpServer::localServers() const

Gibt die lokalen Server dieses HTTP-Servers zurück.

Siehe auch serverPorts().

[pure virtual protected] void QAbstractHttpServer::missingHandler(const QHttpServerRequest &request, QHttpServerResponder &responder)

Überschreiben Sie diese Funktion, um jede eingehende request zu behandeln, die nicht von handleRequest() behandelt wurde. Diese Funktion wird immer dann aufgerufen, wenn handleRequest() false zurückgibt oder wenn es einen WebSocket-Upgrade-Versuch gibt und entweder keine Verbindungen zu newWebSocketConnection() bestehen oder keine passenden WebSocket-Prüfer vorhanden sind. Die Parameter request und responder sind die gleichen, mit denen handleRequest() aufgerufen wurde.

Siehe auch handleRequest() und addWebSocketUpgradeVerifier().

[signal] void QAbstractHttpServer::newWebSocketConnection()

Dieses Signal wird jedes Mal ausgegeben, wenn eine neue WebSocket-Verbindung verfügbar ist.

Siehe auch hasPendingWebSocketConnections(), nextPendingWebSocketConnection(), und addWebSocketUpgradeVerifier().

std::unique_ptr<QWebSocket> QAbstractHttpServer::nextPendingWebSocketConnection()

Gibt die nächste anstehende Verbindung als verbundenes QWebSocket Objekt zurück. nullptr wird zurückgegeben, wenn diese Funktion aufgerufen wird und keine anstehenden Verbindungen bestehen.

Siehe auch newWebSocketConnection(), hasPendingWebSocketConnections(), und addWebSocketUpgradeVerifier().

QList<quint16> QAbstractHttpServer::serverPorts() const

Gibt die Liste der Ports zurück, die diese Instanz von QAbstractHttpServer abhört.

Diese Funktion hat die gleiche Garantie wie QObject::children, der zuletzt hinzugefügte Server ist der letzte Eintrag im Vektor.

Siehe auch servers().

QList<QTcpServer *> QAbstractHttpServer::servers() const

Gibt die TCP- und SSL-Server zurück, von denen dieser HTTP-Server Verbindungen verarbeiten wird.

Siehe auch serverPorts().

[since 6.9] void QAbstractHttpServer::setConfiguration(const QHttpServerConfiguration &config)

Setzt die allgemeinen Konfigurationsparameter dieses Servers auf config.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch configuration().

[since 6.8] void QAbstractHttpServer::setHttp2Configuration(const QHttp2Configuration &configuration)

Setzt die HTTP/2-Konfigurationsparameter des Servers.

Die nächste HTTP/2-Verbindung wird die angegebene configuration verwenden.

Diese Funktion wurde in Qt 6.8 eingeführt.

Siehe auch http2Configuration().