QAbstractHttpServer Class

API to subclass to implement an HTTP server. 更多...

头：	#include <QAbstractHttpServer>
CMake:	find_package(Qt6 REQUIRED COMPONENTS HttpServer) target_link_libraries(mytarget PRIVATE Qt6::HttpServer)
qmake:	QT += httpserver
Since:	Qt 6.4
继承：	QObject
继承者：	QHttpServer
Status:	Technical Preview

所有成员列表，包括继承成员

公共函数

	QAbstractHttpServer (QObject * parent = nullptr)
void	bind (QTcpServer * server = nullptr)
bool	hasPendingWebSocketConnections () const
quint16	listen (const QHostAddress & address = QHostAddress::Any, quint16 port = 0)
std::unique_ptr<QWebSocket>	nextPendingWebSocketConnection ()
QList<quint16>	serverPorts ()
QList<QTcpServer *>	servers () const
void	sslSetup (const QSslCertificate & certificate , const QSslKey & privateKey , QSsl::SslProtocol protocol = QSsl::SecureProtocols)
void	sslSetup (const QSslConfiguration & sslConfiguration )

信号

void	newWebSocketConnection ()

保护函数

virtual bool	handleRequest (const QHttpServerRequest & request , QHttpServerResponder & responder ) = 0
virtual void	missingHandler (const QHttpServerRequest & request , QHttpServerResponder && responder ) = 0

详细描述

Subclass this class and override handleRequest() to create an HTTP server. Use listen() or bind() to start listening to incoming connections.

成员函数文档编制

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

Creates an instance of QAbstractHttpServer with the parent parent .

void QAbstractHttpServer:: bind ( QTcpServer * server = nullptr)

Bind the HTTP server to given TCP server over which the transmission happens. It is possible to call this function multiple times with different instances of TCP server to handle multiple connections and ports, for example both SSL and non-encrypted connections.

After calling this function, every _new_ connection will be handled and forwarded by the HTTP server.

It is the user's responsibility to call QTcpServer::listen () on the server .

若 server is null, then a new, default-constructed TCP server will be constructed, which will be listening on a random port and all interfaces.

The server will be parented to this HTTP server.

另请参阅 QTcpServer and QTcpServer::listen ().

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

Overload this function to handle each incoming request , by examining the request and sending the appropriate response back to responder . Return true 若 request was handled successfully. If this method returns false , missingHandler() will be called afterwards.

This function must move out of responder before returning true .

bool QAbstractHttpServer:: hasPendingWebSocketConnections () const

返回 true if the server has pending WebSocket connections; otherwise returns false .

另请参阅 newWebSocketConnection () 和 nextPendingWebSocketConnection ().

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

Tries to bind a QTcpServer to address and port .

Returns the server port upon success, 0 otherwise.

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

This function is called whenever handleRequest() 返回 false 。 request and responder parameters are the same as handleRequest() was called with.

`[signal]` void QAbstractHttpServer:: newWebSocketConnection ()

This signal is emitted every time a new WebSocket connection is available.

另请参阅 hasPendingWebSocketConnections () 和 nextPendingWebSocketConnection ().

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

返回下一待决连接作为连接的 QWebSocket 对象。 nullptr 被返回若在没有待决连接时调用此函数。

注意： 返回的 QWebSocket 对象不可以用于其它线程。

另请参阅 newWebSocketConnection () 和 hasPendingWebSocketConnections ().

QList < quint16 > QAbstractHttpServer:: serverPorts ()

Returns the list of ports this instance of QAbstractHttpServer is listening to.

This function has the same guarantee as QObject::children , the latest server added is the last entry in the vector.

另请参阅 servers ().

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

Returns list of child TCP servers of this HTTP server.

另请参阅 serverPorts ().

void QAbstractHttpServer:: sslSetup (const QSslCertificate & certificate , const QSslKey & privateKey , QSsl::SslProtocol protocol = QSsl::SecureProtocols)

Turns the server into an HTTPS server.

The next listen () call will use the given certificate , privateKey ，和 protocol .

void QAbstractHttpServer:: sslSetup (const QSslConfiguration & sslConfiguration )