QWebSocketServer Class

Dokumentation der Mitgliedsfunktionen

[explicit] QWebSocketServer::QWebSocketServer(const QString &serverName, QWebSocketServer::SslMode secureMode, QObject *parent = nullptr)

Konstruiert einen neuen QWebSocketServer mit der angegebenen serverName. Die serverName wird in der HTTP-Handshake-Phase verwendet, um den Server zu identifizieren. Er kann leer sein, in diesem Fall wird kein Servername an den Client gesendet. Der Parameter secureMode gibt an, ob der Server über wss (SecureMode) oder über ws (NonSecureMode) arbeitet.

parent wird an den QObject Konstruktor übergeben.

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

Zerstört das Objekt QWebSocketServer. Wenn der Server auf Verbindungen wartet, wird der Socket automatisch geschlossen. Alle noch in der Warteschlange stehenden Clients QWebSocketwerden geschlossen und gelöscht.

Siehe auch close().

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

Dieses Signal wird ausgegeben, wenn bei der Annahme einer neuen Verbindung ein Fehler auftritt. Der Parameter socketError beschreibt die Art des aufgetretenen Fehlers.

Siehe auch pauseAccepting() und resumeAccepting().

[signal, since 6.2] void QWebSocketServer::alertReceived(QSsl::AlertLevel level, QSsl::AlertType type, const QString &description)

QWebSocketServer sendet dieses Signal, wenn eine Warnmeldung von einer Gegenstelle eingegangen ist. level gibt an, ob es sich um eine schwerwiegende oder um eine Warnung handelt. type ist der Code, der erklärt, warum die Warnmeldung gesendet wurde. Wenn eine textuelle Beschreibung der Warnmeldung verfügbar ist, wird sie in description angegeben.

Diese Funktion wurde in Qt 6.2 eingeführt.

Siehe auch alertSent(), QSsl::AlertLevel, und QSsl::AlertType.

[signal, since 6.2] void QWebSocketServer::alertSent(QSsl::AlertLevel level, QSsl::AlertType type, const QString &description)

QWebSocketServer gibt dieses Signal aus, wenn eine Warnmeldung an einen Peer gesendet wurde. level beschreibt, ob es sich um eine Warnung oder einen schwerwiegenden Fehler handelt. type gibt den Code der Warnmeldung an. Wenn eine textuelle Beschreibung der Warnmeldung verfügbar ist, wird sie in description angegeben.

Diese Funktion wurde in Qt 6.2 eingeführt.

Siehe auch alertReceived(), QSsl::AlertLevel, und QSsl::AlertType.

void QWebSocketServer::close()

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

[signal] void QWebSocketServer::closed()

Dieses Signal wird ausgegeben, wenn der Server seine Verbindung geschlossen hat.

Siehe auch close().

QWebSocketProtocol::CloseCode QWebSocketServer::error() const

Gibt einen Fehlercode für den zuletzt aufgetretenen Fehler zurück. Ist kein Fehler aufgetreten, wird QWebSocketProtocol::CloseCodeNormal zurückgegeben.

Siehe auch errorString().

QString QWebSocketServer::errorString() const

Gibt eine menschenlesbare Beschreibung des letzten aufgetretenen Fehlers zurück. Ist kein Fehler aufgetreten, wird eine leere Zeichenkette zurückgegeben.

Siehe auch serverError().

void QWebSocketServer::handleConnection(QTcpSocket *socket) const

Erweitert einen tcp socket zu einem Websocket.

Das Objekt QWebSocketServer übernimmt den Besitz des Socket-Objekts und löscht es bei Bedarf.

[signal, since 6.2] void QWebSocketServer::handshakeInterruptedOnError(const QSslError &error)

QWebSocketServer gibt dieses Signal aus, wenn eine Zertifikatsüberprüfung error gefunden wurde und wenn eine frühzeitige Fehlerberichterstattung in QSslConfiguration aktiviert wurde.

Diese Funktion wurde in Qt 6.2 eingeführt.

Siehe auch sslErrors() und QSslConfiguration::setHandshakeMustInterruptOnError().

std::chrono::milliseconds QWebSocketServer::handshakeTimeout() const

Gibt den Handshake-Timeout für neue Verbindungen in Millisekunden zurück.

Der Standardwert ist 10 Sekunden. Wenn ein Peer mehr Zeit benötigt, um den Handshake abzuschließen, wird seine Verbindung geschlossen.

Siehe auch setHandshakeTimeout() und handshakeTimeoutMS().

int QWebSocketServer::handshakeTimeoutMS() const

Gibt den Handshake-Timeout für neue Verbindungen in Millisekunden zurück.

Der Standardwert ist 10 Sekunden. Wenn ein Peer mehr Zeit benötigt, um den Handshake abzuschließen, wird seine Verbindung geschlossen.

Siehe auch setHandshakeTimeout() und handshakeTimeout().

bool QWebSocketServer::hasPendingConnections() const

Gibt true zurück, wenn der Server über ausstehende Verbindungen verfügt; andernfalls wird false zurückgegeben.

Siehe auch nextPendingConnection() und setMaxPendingConnections().

bool QWebSocketServer::isListening() const

Gibt true zurück, wenn der Server gerade auf eingehende Verbindungen wartet; andernfalls wird false zurückgegeben. Wenn das Lauschen fehlschlägt, gibt error() den Grund zurück.

Siehe auch listen() und error().

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

Weist den Server an, auf eingehende Verbindungen an der Adresse address und dem Port port zu warten. Wenn port gleich 0 ist, wird automatisch ein Port gewählt. Wenn address gleich QHostAddress::Any ist, lauscht der Server an allen Netzwerkschnittstellen.

Gibt bei Erfolg true zurück, andernfalls false.

Siehe auch isListening().

int QWebSocketServer::maxPendingConnections() const

Gibt die maximale Anzahl der anstehenden akzeptierten Verbindungen zurück. Der Standardwert ist 30.

Siehe auch setMaxPendingConnections() und hasPendingConnections().

[signal] void QWebSocketServer::newConnection()

Dieses Signal wird jedes Mal ausgesendet, wenn eine neue Verbindung verfügbar ist.

Siehe auch hasPendingConnections() und nextPendingConnection().

[virtual] QWebSocket *QWebSocketServer::nextPendingConnection()

Gibt die nächste anstehende Verbindung als verbundenes QWebSocket Objekt zurück. QWebSocketServer übernimmt nicht das Eigentum an dem zurückgegebenen QWebSocket Objekt. Es obliegt dem Aufrufer, das Objekt explizit zu löschen, wenn es nicht mehr verwendet wird, da sonst ein Speicherleck entsteht. nullptr wird zurückgegeben, wenn diese Funktion aufgerufen wird, wenn es keine anstehenden Verbindungen gibt.

Hinweis: Das zurückgegebene QWebSocket Objekt kann nicht von einem anderen Thread verwendet werden.

Siehe auch hasPendingConnections().

[signal] void QWebSocketServer::originAuthenticationRequired(QWebSocketCorsAuthenticator *authenticator)

Dieses Signal wird ausgesendet, wenn eine neue Verbindung angefordert wird. Der mit diesem Signal verbundene Slot sollte angeben, ob der Ursprung (der durch den origin()-Aufruf ermittelt werden kann) im authenticator -Objekt erlaubt ist (durch Ausgabe von setAllowed()).

Wenn kein Slot mit diesem Signal verbunden ist, werden standardmäßig alle Ursprünge akzeptiert.

void QWebSocketServer::pauseAccepting()

Unterbricht eingehende neue Verbindungen. In der Warteschlange befindliche Verbindungen bleiben in der Warteschlange.

Siehe auch resumeAccepting().

[signal] void QWebSocketServer::peerVerifyError(const QSslError &error)

QWebSocketServer kann dieses Signal mehrmals während des SSL-Handshakes aussenden, bevor die Verschlüsselung aufgebaut ist, um anzuzeigen, dass bei der Feststellung der Identität der Gegenstelle ein Fehler aufgetreten ist. Die error ist in der Regel ein Hinweis darauf, dass QWebSocketServer nicht in der Lage ist, die Gegenstelle sicher zu identifizieren.

Dieses Signal gibt Ihnen einen frühen Hinweis darauf, dass etwas nicht in Ordnung ist. Wenn Sie eine Verbindung zu diesem Signal herstellen, können Sie manuell entscheiden, ob Sie die Verbindung innerhalb des angeschlossenen Slots abbauen wollen, bevor der Handshake abgeschlossen ist. Wird nichts unternommen, fährt QWebSocketServer mit der Ausgabe von QWebSocketServer::sslErrors() fort.

Siehe auch sslErrors().

[signal] void QWebSocketServer::preSharedKeyAuthenticationRequired(QSslPreSharedKeyAuthenticator *authenticator)

QWebSocketServer sendet dieses Signal, wenn er eine PSK-Ciphersuite aushandelt, so dass eine PSK-Authentifizierung erforderlich ist.

Bei der Verwendung von PSK muss der Client dem Server eine gültige Identität und einen gültigen Pre-Shared Key senden, damit der SSL-Handshake fortgesetzt werden kann. Anwendungen können diese Informationen in einem mit diesem Signal verbundenen Slot bereitstellen, indem sie das übergebene authenticator Objekt entsprechend ihren Bedürfnissen ausfüllen.

Siehe auch QSslPreSharedKeyAuthenticator und QSslSocket::preSharedKeyAuthenticationRequired().

QNetworkProxy QWebSocketServer::proxy() const

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

Siehe auch setProxy().

void QWebSocketServer::resumeAccepting()

Nimmt wieder neue Verbindungen an.

Siehe auch pauseAccepting().

QWebSocketServer::SslMode QWebSocketServer::secureMode() const

Gibt den sicheren Modus zurück, in dem der Server läuft.

Siehe auch QWebSocketServer() und SslMode.

QHostAddress QWebSocketServer::serverAddress() const

Gibt die Adresse des Servers zurück, wenn der Server auf Verbindungen wartet; andernfalls wird QHostAddress::Null zurückgegeben.

Siehe auch serverPort() und listen().

[signal] void QWebSocketServer::serverError(QWebSocketProtocol::CloseCode closeCode)

Dieses Signal wird ausgegeben, wenn beim Aufbau einer WebSocket-Verbindung ein Fehler auftritt. Der Parameter closeCode beschreibt den Typ des aufgetretenen Fehlers

Siehe auch errorString().

QString QWebSocketServer::serverName() const

Gibt den Servernamen zurück, der während der http-Handshake-Phase verwendet wird.

Siehe auch setServerName().

quint16 QWebSocketServer::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().

QUrl QWebSocketServer::serverUrl() const

Gibt eine URL zurück, die Clients verwenden können, um eine Verbindung zu diesem Server herzustellen, wenn der Server auf Verbindungen wartet. Andernfalls wird eine ungültige URL zurückgegeben.

Siehe auch serverPort(), serverAddress(), und listen().

void QWebSocketServer::setHandshakeTimeout(std::chrono::milliseconds msec)

Setzt den Handshake-Timeout für neue Verbindungen auf msec Millisekunden.

Standardmäßig ist dieser Wert auf 10 Sekunden eingestellt. Wenn ein Peer mehr Zeit benötigt, um den Handshake abzuschließen, wird seine Verbindung geschlossen. Sie können einen negativen Wert (z. B. -1) übergeben, um den Timeout zu deaktivieren.

Siehe auch handshakeTimeout() und handshakeTimeoutMS().

void QWebSocketServer::setHandshakeTimeout(int msec)

Dies ist eine überladene Funktion.

void QWebSocketServer::setMaxPendingConnections(int numConnections)

Legt die maximale Anzahl der anstehenden akzeptierten Verbindungen auf numConnections fest. WebSocketServer akzeptiert nicht mehr als numConnections eingehende Verbindungen, bevor nextPendingConnection() aufgerufen wird. Standardmäßig liegt die Grenze bei 30 anstehenden Verbindungen.

QWebSocketServer gibt das Signal error() mit dem Code QWebSocketProtocol::CloseCodeAbnormalDisconnection close aus, wenn die maximale Anzahl von Verbindungen erreicht wurde. Der WebSocket-Handshake schlägt fehl und der Socket wird geschlossen.

Siehe auch maxPendingConnections() und hasPendingConnections().

void QWebSocketServer::setProxy(const QNetworkProxy &networkProxy)

Setzt den expliziten Netzwerkproxy für diesen Server auf networkProxy.

Um die Verwendung eines Proxys zu deaktivieren, verwenden Sie den Proxy-Typ QNetworkProxy::NoProxy:

server->setProxy(QNetworkProxy::NoProxy);

Siehe auch proxy().

void QWebSocketServer::setServerName(const QString &serverName)

Setzt den Servernamen, der während der HTTP-Handshake-Phase verwendet wird, auf den angegebenen serverName. serverName kann leer sein; in diesem Fall wird ein leerer Servername an den Client gesendet. Bereits verbundene Clients werden über diese Änderung nicht benachrichtigt, nur neu verbundene Clients sehen diesen neuen Namen.

Siehe auch serverName().

bool QWebSocketServer::setSocketDescriptor(qintptr socketDescriptor)

Legt den Socket-Deskriptor fest, den dieser Server verwenden soll, wenn er auf eingehende Verbindungen zu socketDescriptor wartet.

Gibt true zurück, wenn der Socket erfolgreich gesetzt wurde; andernfalls wird false zurückgegeben. Es wird davon ausgegangen, dass sich der Socket im Lauschzustand befindet.

Siehe auch socketDescriptor() und isListening().

void QWebSocketServer::setSslConfiguration(const QSslConfiguration &sslConfiguration)

Setzt die SSL-Konfiguration für QWebSocketServer auf sslConfiguration. Diese Methode hat keine Wirkung, wenn QWebSocketServer im nicht sicheren Modus (QWebSocketServer::NonSecureMode) läuft.

Siehe auch sslConfiguration() und SslMode.

[since 6.4] void QWebSocketServer::setSupportedSubprotocols(const QStringList &protocols)

Setzt die Liste der vom Server unterstützten Protokolle auf protocols.

Diese Funktion wurde in Qt 6.4 eingeführt.

Siehe auch supportedSubprotocols().

qintptr QWebSocketServer::socketDescriptor() const

Gibt den nativen Socket-Deskriptor zurück, den der Server verwendet, um auf eingehende Anweisungen zu warten, oder -1, wenn der Server nicht wartet. Wenn der Server QNetworkProxy verwendet, ist der zurückgegebene Deskriptor möglicherweise nicht mit nativen Socket-Funktionen verwendbar.

Siehe auch setSocketDescriptor() und isListening().

QSslConfiguration QWebSocketServer::sslConfiguration() const

Gibt die vom QWebSocketServer verwendete SSL-Konfiguration zurück. Wenn der Server nicht im sicheren Modus läuft (QWebSocketServer::SecureMode), gibt diese Methode QSslConfiguration::defaultConfiguration() zurück.

Siehe auch setSslConfiguration(), SslMode, und QSslConfiguration::defaultConfiguration().

[signal] void QWebSocketServer::sslErrors(const QList<QSslError> &errors)

QWebSocketServer gibt dieses Signal nach dem SSL-Handshake aus, um anzuzeigen, dass ein oder mehrere Fehler bei der Feststellung der Identität der Gegenstelle aufgetreten sind. Die Fehler sind in der Regel ein Hinweis darauf, dass QWebSocketServer nicht in der Lage ist, die Gegenstelle sicher zu identifizieren. Wenn keine Maßnahmen ergriffen werden, wird die Verbindung nach der Ausgabe dieses Signals abgebrochen.

errors enthält einen oder mehrere Fehler, die QSslSocket daran hindern, die Identität der Gegenstelle zu überprüfen.

Siehe auch peerVerifyError().

[since 6.4] QStringList QWebSocketServer::supportedSubprotocols() const

Gibt die Liste der vom Server unterstützten Protokolle zurück.

Diese Funktion wurde in Qt 6.4 eingeführt.

Siehe auch setSupportedSubprotocols().

QList<QWebSocketProtocol::Version> QWebSocketServer::supportedVersions() const

Gibt eine Liste der WebSocket-Versionen zurück, die dieser Server unterstützt.