QAbstractHttpServer Class
API de la que hay que crear una subclase para implementar un servidor HTTP. Más información...
| Encabezado: | #include <QAbstractHttpServer> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS HttpServer) target_link_libraries(mytarget PRIVATE Qt6::HttpServer) |
| qmake: | QT += httpserver |
| Desde: | Qt 6.4 |
| Heredado de: | QObject |
| Heredado por: |
Funciones públicas
| QAbstractHttpServer(QObject *parent = nullptr) | |
| virtual | ~QAbstractHttpServer() override |
(since 6.8) void | addWebSocketUpgradeVerifier(const QObject *context, Handler &&func) |
| bool | bind(QLocalServer *server) |
| bool | bind(QTcpServer *server) |
(since 6.9) QHttpServerConfiguration | configuration() const |
| bool | hasPendingWebSocketConnections() const |
(since 6.8) QHttp2Configuration | http2Configuration() const |
| QList<QLocalServer *> | localServers() const |
| std::unique_ptr<QWebSocket> | nextPendingWebSocketConnection() |
| QList<quint16> | serverPorts() const |
| QList<QTcpServer *> | servers() const |
(since 6.9) void | setConfiguration(const QHttpServerConfiguration &config) |
(since 6.8) void | setHttp2Configuration(const QHttp2Configuration &configuration) |
Señales
| void | newWebSocketConnection() |
Funciones protegidas
| virtual bool | handleRequest(const QHttpServerRequest &request, QHttpServerResponder &responder) = 0 |
| virtual void | missingHandler(const QHttpServerRequest &request, QHttpServerResponder &responder) = 0 |
Descripción detallada
Subclasifica esta clase y sobrescribe ` handleRequest()` y ` missingHandler()` para crear un servidor HTTP. Utiliza ` bind()` para comenzar a escuchar todas las conexiones entrantes al servidor.
Se trata de una API de bajo nivel; consulta QHttpServer para obtener una API de nivel superior con la que implementar un servidor HTTP.
Documentación de funciones de miembro
[explicit] QAbstractHttpServer::QAbstractHttpServer(QObject *parent = nullptr)
Crea una instancia de `QAbstractHttpServer` con el padre ` parent`.
[override virtual noexcept] QAbstractHttpServer::~QAbstractHttpServer()
Elimina una instancia de « QAbstractHttpServer ».
[since 6.8] template <typename Handler> void QAbstractHttpServer::addWebSocketUpgradeVerifier(const QObject *context, Handler &&func)
Añade una función de devolución de llamada ` func ` que verifica las actualizaciones entrantes de WebSocket. Se invoca utilizando el objeto ` context ` proporcionado. Una actualización se considera correcta si al menos una función de devolución de llamada registrada devuelve ` Accept ` y ninguna función de devolución de llamada anterior ha devuelto ` Deny`. Si no hay ninguna función de devolución de llamada registrada, o si todas devuelven ` PassToNext`, se invoca la función ` missingHandler()`. Las funciones de llamada de retorno se ejecutan en el orden en que se registraron y no pueden llamar a esta función por sí mismas.
Nota: La clase ` func ` debe implementar la firma ` QHttpServerWebSocketUpgradeResponse (*)(const QHttpServerRequest &)`.
server.addWebSocketUpgradeVerifier(
&server, [](const QHttpServerRequest &request) {
if (request.url().path() == "/allowed"_L1)
return QHttpServerWebSocketUpgradeResponse::accept();
else
return QHttpServerWebSocketUpgradeResponse::passToNext();
});Esta función se introdujo en Qt 6.8.
Véase también QHttpServerRequest, QHttpServerWebSocketUpgradeResponse, hasPendingWebSocketConnections(), nextPendingWebSocketConnection(), newWebSocketConnection() y missingHandler().
bool QAbstractHttpServer::bind(QLocalServer *server)
Asigna al servidor HTTP el QLocalServer server indicado, a través del cual se realiza la transmisión. Es posible llamar a esta función varias veces con diferentes instancias de server para gestionar múltiples conexiones.
Tras llamar a esta función, el servidor HTTP gestionará y reenviará todas las nuevas conexiones.
Es responsabilidad del usuario llamar a ` QLocalServer::listen()` en ` server ` antes de llamar a esta función. Si ` server ` no está a la escucha, no ocurrirá nada y se devolverá ` false `.
Si server es nullptr, se devuelve false.
Si se realiza correctamente, el server pasará a estar vinculado a este servidor HTTP y se devuelve true.
Véanse también QLocalServer y QLocalServer::listen().
bool QAbstractHttpServer::bind(QTcpServer *server)
Asigna el TCP server, a través del cual se realiza la transmisión, al servidor HTTP. Es posible llamar a esta función varias veces con diferentes instancias de TCP server para gestionar múltiples conexiones y puertos; por ejemplo, tanto conexiones SSL como no cifradas.
Tras llamar a esta función, el servidor HTTP gestionará y reenviará todas las nuevas conexiones.
Es responsabilidad del usuario llamar a ` QTcpServer::listen()` en ` server ` antes de llamar a esta función. Si ` server ` no está a la escucha, no ocurrirá nada y se devolverá ` false `.
Si se realiza correctamente, el server se vinculará a este servidor HTTP y se devolverá true.
Para permitir el uso de HTTP 2, hay que vincularse a un ` QSslServer ` en el que se haya llamado a ` QSslConfiguration::setAllowedNextProtocols()` con los argumentos ` { QSslConfiguration::ALPNProtocolHTTP2 }`.
Véase también QTcpServer, QTcpServer::listen() y QSslConfiguration::setAllowedNextProtocols().
[since 6.9] QHttpServerConfiguration QAbstractHttpServer::configuration() const
Devuelve los parámetros generales de configuración de este servidor.
Esta función se introdujo en Qt 6.9.
Véase también ` setConfiguration()`.
[pure virtual protected] bool QAbstractHttpServer::handleRequest(const QHttpServerRequest &request, QHttpServerResponder &responder)
Sobrescribe esta función para gestionar cada request entrante, analizando el request y enviando la respuesta adecuada a responder. Devuelve true si el request se ha gestionado correctamente. Si este método devuelve false, se llamará posteriormente a missingHandler().
bool QAbstractHttpServer::hasPendingWebSocketConnections() const
Devuelve « true » si el servidor tiene conexiones WebSocket pendientes; en caso contrario, devuelve « false ».
Véase también newWebSocketConnection(), nextPendingWebSocketConnection() y addWebSocketUpgradeVerifier().
[since 6.8] QHttp2Configuration QAbstractHttpServer::http2Configuration() const
Devuelve los parámetros de configuración HTTP/2 del servidor.
Esta función se introdujo en Qt 6.8.
Véase también setHttp2Configuration().
QList<QLocalServer *> QAbstractHttpServer::localServers() const
Devuelve los servidores locales de este servidor HTTP.
Véase también serverPorts().
[pure virtual protected] void QAbstractHttpServer::missingHandler(const QHttpServerRequest &request, QHttpServerResponder &responder)
Sobrescribe esta función para gestionar cada request entrante que no haya sido gestionado por handleRequest(). Esta función se invoca cada vez que handleRequest() devuelve false, o si se produce un intento de actualización de WebSocket y no hay conexiones a newWebSocketConnection() o no hay verificadores de WebSocket que coincidan. Los parámetros request y responder son los mismos con los que se invocó handleRequest().
Véase también handleRequest() y addWebSocketUpgradeVerifier().
[signal] void QAbstractHttpServer::newWebSocketConnection()
Esta señal se emite cada vez que hay una nueva conexión WebSocket disponible.
Véase también hasPendingWebSocketConnections(), nextPendingWebSocketConnection() y addWebSocketUpgradeVerifier().
std::unique_ptr<QWebSocket> QAbstractHttpServer::nextPendingWebSocketConnection()
Devuelve la siguiente conexión pendiente como un objeto ` QWebSocket ` conectado. Se devuelve ` nullptr ` si se llama a esta función cuando no hay conexiones pendientes.
Nota: El objeto ` QWebSocket ` devuelto no se puede utilizar desde otro hilo.
Véase también newWebSocketConnection(), hasPendingWebSocketConnections() y addWebSocketUpgradeVerifier().
QList<quint16> QAbstractHttpServer::serverPorts() const
Devuelve la lista de puertos en los que está a la escucha esta instancia de QAbstractHttpServer.
Esta función ofrece la misma garantía que QObject::children: el último servidor añadido es la última entrada del vector.
Véase también servers().
QList<QTcpServer *> QAbstractHttpServer::servers() const
Devuelve los servidores TCP y SSL desde los que este servidor HTTP gestionará las conexiones.
Véase también serverPorts().
[since 6.9] void QAbstractHttpServer::setConfiguration(const QHttpServerConfiguration &config)
Establece los parámetros generales de configuración de este servidor en config.
Nota: La nueva configuración se aplicará tanto a las conexiones ya establecidas como a todas las conexiones futuras.
Esta función se introdujo en Qt 6.9.
Véase también configuration().
[since 6.8] void QAbstractHttpServer::setHttp2Configuration(const QHttp2Configuration &configuration)
Establece los parámetros de configuración HTTP/2 del servidor.
La próxima conexión HTTP/2 utilizará el valor especificado en ` configuration`.
Esta función se introdujo en Qt 6.8.
Véase también ` http2Configuration()`.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.