QWebSocketServer Class

Dokumentation der Mitgliedsfunktionen

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

Erstellt einen neuen QWebSocketServer mit dem angegebenen „ serverName “. Der „ serverName “ wird in der HTTP-Handshake-Phase zur Identifizierung des Servers verwendet. 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) betrieben wird.

parent wird an den Konstruktor „ QObject “ übergeben.

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

Löscht das Objekt „ QWebSocketServer “. Wenn der Server auf Verbindungen wartet, wird der Socket automatisch geschlossen. Alle noch in der Warteschlange befindlichen Client- QWebSocketen werden geschlossen und gelöscht.

Siehe auch close().

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

Dieses Signal wird ausgelöst, wenn beim Annehmen 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 Gibt dieses Signal aus, wenn eine Warnmeldung von einem Peer empfangen wurde. level gibt an, ob es sich bei der Warnung um einen schwerwiegenden Fehler oder um eine Warnung handelte. type ist der Code, der erklärt, warum die Warnung gesendet wurde. Wenn eine textuelle Beschreibung der Warnmeldung verfügbar ist, wird diese unter description bereitgestellt.

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 “ gibt an, ob es sich um eine Warnung oder einen schwerwiegenden Fehler handelte. „ type “ liefert den Code der Warnmeldung. Ist eine textuelle Beschreibung der Warnmeldung verfügbar, wird diese unter „ description “ bereitgestellt.

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 nun nicht mehr auf eingehende Verbindungen.

[signal] void QWebSocketServer::closed()

Dieses Signal wird ausgesendet, wenn der Server die Verbindung geschlossen hat.

Siehe auch ` close()`.

QWebSocketProtocol::CloseCode QWebSocketServer::error() const

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

Siehe auch ` errorString()`.

QString QWebSocketServer::errorString() const

Gibt eine für Menschen lesbare Beschreibung des zuletzt aufgetretenen Fehlers zurück. Wenn kein Fehler aufgetreten ist, wird eine leere Zeichenkette zurückgegeben.

Siehe auch ` serverError()`.

void QWebSocketServer::handleConnection(QTcpSocket *socket) const

Erweitert ein TCP- socket -Objekt auf WebSocket.

Das ` QWebSocketServer `-Objekt übernimmt die Verantwortung für das Socket-Objekt und löscht es zum geeigneten Zeitpunkt.

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

QWebSocketServer Gibt dieses Signal aus, wenn ein Zertifikatsüberprüfungs error gefunden wurde und die frühzeitige Fehlermeldung unter 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 das Handshake-Timeout für neue Verbindungen in Millisekunden zurück.

Der Standardwert beträgt 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 das Handshake-Timeout für neue Verbindungen in Millisekunden zurück.

Der Standardwert beträgt 10 Sekunden. Wenn ein Peer mehr Zeit für den Handshake benötigt, wird dessen Verbindung geschlossen.

Siehe auch setHandshakeTimeout() und handshakeTimeout().

bool QWebSocketServer::hasPendingConnections() const

Gibt „true“ zurück, wenn der Server offene Verbindungen hat; andernfalls gibt er „false“ zurück.

Siehe auch nextPendingConnection() und setMaxPendingConnections().

bool QWebSocketServer::isListening() const

Gibt „true“ zurück, wenn der Server derzeit auf eingehende Verbindungen wartet; andernfalls wird „false“ zurückgegeben. Wenn das Warten 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 unter der Adresse address und dem Port port zu warten. Ist port gleich 0, wird automatisch ein Port ausgewählt. Ist address gleich QHostAddress::Any, wartet der Server auf allen Netzwerkschnittstellen.

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

Siehe auch isListening().

int QWebSocketServer::maxPendingConnections() const

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

Siehe auch setMaxPendingConnections() und hasPendingConnections().

[signal] void QWebSocketServer::newConnection()

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

Siehe auch hasPendingConnections() und nextPendingConnection().

[virtual] QWebSocket *QWebSocketServer::nextPendingConnection()

Gibt die nächste ausstehende Verbindung als verbundenes „ QWebSocket “-Objekt zurück. „ QWebSocketServer “ übernimmt nicht die Verantwortung für das zurückgegebene „ QWebSocket “-Objekt. Es obliegt dem Aufrufer, das Objekt explizit zu löschen, sobald es nicht mehr benötigt wird; andernfalls kommt es zu einem Speicherleck. Wird diese Funktion aufgerufen, während keine Verbindungen ausstehen, wird „nullptr“ zurückgegeben.

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

Siehe auch hasPendingConnections().

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

Dieses Signal wird ausgelöst, wenn eine neue Verbindung angefordert wird. Der mit diesem Signal verbundene Slot sollte angeben, ob die Quelle (die über den Aufruf von `origin()` ermittelt werden kann) im Objekt ` authenticator ` zugelassen ist (durch Auslösen von ` setAllowed()`).

Ist kein Slot an dieses Signal angeschlossen, werden standardmäßig alle Ursprünge akzeptiert.

void QWebSocketServer::pauseAccepting()

Hält eingehende neue Verbindungen an. Verbindungen in der Warteschlange verbleiben dort.

Siehe auch resumeAccepting().

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

QWebSocketServer kann dieses Signal während des SSL-Handshakes mehrmals aussenden, bevor die Verschlüsselung hergestellt wurde, um anzuzeigen, dass beim Feststellen der Identität des Gegenübers ein Fehler aufgetreten ist. Das Signal „ error “ ist in der Regel ein Hinweis darauf, dass „ QWebSocketServer “ den Gegenüber nicht sicher identifizieren kann.

Dieses Signal liefert Ihnen einen frühzeitigen Hinweis darauf, dass etwas nicht stimmt. Indem Sie sich an dieses Signal anbinden, können Sie manuell entscheiden, die Verbindung aus dem verbundenen Slot heraus abzubrechen, bevor der Handshake abgeschlossen ist. Wenn keine Maßnahmen ergriffen werden, sendet „ QWebSocketServer “ anschließend „ QWebSocketServer::sslErrors “ ().

Siehe auch sslErrors().

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

QWebSocketServer gibt dieses Signal aus, wenn es eine PSK-Verschlüsselungssuite aushandelt; daher ist anschließend eine PSK-Authentifizierung erforderlich.

Bei Verwendung von PSK muss der Client dem Server eine gültige Identität und einen gültigen vorab geteilten Schlüssel übermitteln, 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 Anforderungen 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 Sicherheitsmodus zurück, in dem der Server ausgeführt wird.

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 ausgelöst, wenn beim Aufbau einer WebSocket-Verbindung ein Fehler auftritt. Der Parameter „ closeCode “ beschreibt die Art 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, über die Clients eine Verbindung zu diesem Server herstellen können, sofern 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)

Legt das Handshake-Timeout für neue Verbindungen zu msec auf Millisekunden fest.

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

Siehe auch handshakeTimeout() und handshakeTimeoutMS().

void QWebSocketServer::setHandshakeTimeout(int msec)

void QWebSocketServer::setMaxPendingConnections(int numConnections)

Legt die maximale Anzahl ausstehender akzeptierter Verbindungen auf numConnections fest. WebSocketServer akzeptiert nicht mehr als numConnections eingehende Verbindungen, bevor nextPendingConnection() aufgerufen wird. Standardmäßig beträgt das Limit 30 ausstehende Verbindungen.

QWebSocketServer Gibt das Signal ` error()` mit dem ` QWebSocketProtocol::CloseCodeAbnormalDisconnection `-Schließcode aus, wenn die maximale Anzahl an 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)

Legt den expliziten Netzwerk-Proxy für diesen Server auf networkProxy fest.

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)

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

Siehe auch serverName().

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

void QWebSocketServer::setSslConfiguration(const QSslConfiguration &sslConfiguration)

Legt die SSL-Konfiguration für QWebSocketServer auf sslConfiguration fest. Diese Methode hat keine Auswirkung, wenn QWebSocketServer im ungesicherten Modus (QWebSocketServer::NonSecureMode) ausgeführt wird.

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 zum Abhören eingehender Befehle verwendet, oder -1, wenn der Server nicht im Listen-Modus ist. Verwendet der Server „ QNetworkProxy “, ist der zurückgegebene Deskriptor möglicherweise nicht mit nativen Socket-Funktionen verwendbar.

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

QSslConfiguration QWebSocketServer::sslConfiguration() const

Gibt die von „ 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 beim Feststellen der Identität des Gegenübers ein oder mehrere Fehler aufgetreten sind.

Die Fehler deuten in der Regel darauf hin, dass QWebSocketServer den Gegenpart nicht sicher identifizieren kann. Sofern keine Maßnahmen ergriffen werden, wird die Verbindung nach dem Aussenden dieses Signals getrennt.

errors enthält einen oder mehrere Fehler, die „ QSslSocket “ daran hindern, die Identität des Gegenübers zu überprüfen.

Siehe auch „ peerVerifyError “ () und „ sslErrorsOccurred “ ().

[signal, since 6.11] void QWebSocketServer::sslErrorsOccurred(QSslSocket *socket, const QList<QSslError> &errors)

QWebSocketServer gibt dieses Signal nach dem SSL-Handshake aus, um anzuzeigen, dass beim Feststellen der Identität des Gegenübers ein oder mehrere Fehler aufgetreten sind.

Die Fehler deuten in der Regel darauf hin, dass socket den Gegenpart nicht sicher identifizieren kann. Sofern keine Maßnahmen ergriffen werden, wird die Verbindung nach Ausgabe dieses Signals unterbrochen.

errors enthält einen oder mehrere Fehler, die „ QSslSocket “ daran hindern, die Identität des Gegenübers zu überprüfen.

Wenn Sie die Verbindung trotz der aufgetretenen Fehler fortsetzen möchten, müssen Sie ` QSslSocket::ignoreSslErrors()` innerhalb eines Slots aufrufen, der mit diesem Signal verbunden ist. Wenn Sie zu einem späteren Zeitpunkt auf die Fehlerliste zugreifen müssen, können Sie ` QSslSocket::sslHandshakeErrors()` aufrufen.

Diese Funktion wurde in Qt 6.11 eingeführt.

Siehe auch „ peerVerifyError()“ und „ sslErrors()“.

[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.