QWebSocketServer Class

Documentación de las funciones miembro

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

Construye un nuevo QWebSocketServer con la dirección serverName. El serverName sera usado en la fase de handshake HTTP para identificar al servidor. Puede estar vacio, en cuyo caso no se enviara ningun nombre de servidor al cliente. El parámetro secureMode indica si el servidor opera sobre wss (SecureMode) o sobre ws (NonSecureMode).

parent se pasa al constructor QObject.

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

Destruye el objeto QWebSocketServer. Si el servidor está escuchando conexiones, el socket se cierra automáticamente. Cualquier cliente QWebSocketque aún esté en cola se cierra y se elimina.

Véase también close().

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

Esta señal se emite cuando la aceptación de una nueva conexión da lugar a un error. El parámetro socketError describe el tipo de error que se ha producido.

Véase también pauseAccepting() y resumeAccepting().

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

QWebSocketServer emite esta señal si se ha recibido un mensaje de alerta de un par. level indica si la alerta era fatal o era una advertencia. type es el código que explica por qué se envió la alerta. Cuando se dispone de una descripción textual del mensaje de alerta, se proporciona en description.

Esta función se introdujo en Qt 6.2.

Véase también alertSent(), QSsl::AlertLevel, y QSsl::AlertType.

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

QWebSocketServer emite esta señal si se ha enviado un mensaje de alerta a un par. level describe si se trata de una advertencia o de un error fatal. type proporciona el código del mensaje de alerta. Cuando se dispone de una descripción textual del mensaje de alerta, se proporciona en description.

Esta función se introdujo en Qt 6.2.

Ver también alertReceived(), QSsl::AlertLevel, y QSsl::AlertType.

void QWebSocketServer::close()

Cierra el servidor. El servidor dejará de escuchar conexiones entrantes.

[signal] void QWebSocketServer::closed()

Esta señal se emite cuando el servidor cierra su conexión.

Véase también close().

QWebSocketProtocol::CloseCode QWebSocketServer::error() const

Devuelve un código de error para el último error ocurrido. Si no se ha producido ningún error, se devuelve QWebSocketProtocol::CloseCodeNormal.

Véase también errorString().

QString QWebSocketServer::errorString() const

Devuelve una descripción legible del último error que se ha producido. Si no se ha producido ningún error, se devuelve una cadena vacía.

Véase también serverError().

void QWebSocketServer::handleConnection(QTcpSocket *socket) const

Actualiza un tcp socket a websocket.

El objeto QWebSocketServer tomará posesión del objeto socket y lo borrará cuando sea apropiado.

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

QWebSocketServer emite esta señal si se ha encontrado una verificación de certificado error y si se ha activado la notificación anticipada de errores en QSslConfiguration.

Esta función se introdujo en Qt 6.2.

Véase también sslErrors() y QSslConfiguration::setHandshakeMustInterruptOnError().

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

Devuelve el tiempo de espera para nuevas conexiones en milisegundos.

El valor predeterminado es 10 segundos. Si un peer utiliza más tiempo para completar el handshake su conexión se cierra.

Véase también setHandshakeTimeout() y handshakeTimeoutMS().

int QWebSocketServer::handshakeTimeoutMS() const

Devuelve el tiempo de espera para nuevas conexiones en milisegundos.

El valor predeterminado es 10 segundos. Si un peer utiliza más tiempo para completar el handshake su conexión se cierra.

Véase también setHandshakeTimeout() y handshakeTimeout().

bool QWebSocketServer::hasPendingConnections() const

Devuelve true si el servidor tiene conexiones pendientes; en caso contrario devuelve false.

Véase también nextPendingConnection() y setMaxPendingConnections().

bool QWebSocketServer::isListening() const

Devuelve true si el servidor está actualmente a la escucha de conexiones entrantes; en caso contrario devuelve false. Si la escucha falla, error() devolverá la razón.

Véase también listen() y error().

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

Indica al servidor que escuche las conexiones entrantes en la dirección address y el puerto port. Si port es 0, se elige un puerto automáticamente. Si address es QHostAddress::Any, el servidor escuchará en todas las interfaces de red.

Devuelve true en caso de éxito; en caso contrario devuelve false.

Véase también isListening().

int QWebSocketServer::maxPendingConnections() const

Devuelve el número máximo de conexiones aceptadas pendientes. El valor por defecto es 30.

Véase también setMaxPendingConnections() y hasPendingConnections().

[signal] void QWebSocketServer::newConnection()

Esta señal se emite cada vez que hay una nueva conexión disponible.

Véase también hasPendingConnections() y nextPendingConnection().

[virtual] QWebSocket *QWebSocketServer::nextPendingConnection()

Devuelve la siguiente conexión pendiente como un objeto QWebSocket conectado. QWebSocketServer no se apropia del objeto QWebSocket devuelto. Depende de la persona que llama para eliminar el objeto explícitamente cuando ya no se va a utilizar, de lo contrario se producirá una fuga de memoria. nullptr se devuelve si esta función se llama cuando no hay conexiones pendientes.

Nota: El objeto QWebSocket devuelto no puede ser utilizado desde otro hilo.

Véase también hasPendingConnections().

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

Esta señal se emite cuando se solicita una nueva conexión. La ranura conectada a esta señal debe indicar si el origen (que puede determinarse mediante la llamada a origin()) está permitido en el objeto authenticator (emitiendo setAllowed()).

Si no se conecta ninguna ranura a esta señal, se aceptarán todos los orígenes por defecto.

void QWebSocketServer::pauseAccepting()

Pone en pausa las nuevas conexiones entrantes. Las conexiones en cola permanecerán en cola.

Véase también resumeAccepting().

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

QWebSocketServer puede emitir esta señal varias veces durante el handshake SSL, antes de que se haya establecido el cifrado, para indicar que se ha producido un error al establecer la identidad del peer. La error suele ser una indicación de que QWebSocketServer es incapaz de identificar de forma segura al peer.

Esta señal te proporciona una indicación temprana de que algo va mal. Al conectarte a esta señal, puedes elegir manualmente cortar la conexión desde dentro de la ranura conectada antes de que el apretón de manos se haya completado. Si no se realiza ninguna acción, QWebSocketServer procederá a emitir QWebSocketServer::sslErrors().

Véase también sslErrors().

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

QWebSocketServer emite esta señal cuando negocia un ciphersuite PSK, y por lo tanto se requiere entonces una autenticación PSK.

Cuando se utiliza PSK, el cliente debe enviar al servidor una identidad válida y una clave precompartida válida, para que el handshake SSL pueda continuar. Las aplicaciones pueden proporcionar esta información en una ranura conectada a esta señal, rellenando el objeto authenticator pasado según sus necesidades.

Véase también QSslPreSharedKeyAuthenticator y QSslSocket::preSharedKeyAuthenticationRequired().

QNetworkProxy QWebSocketServer::proxy() const

Devuelve el proxy de red para este servidor. Por defecto se usa QNetworkProxy::DefaultProxy.

Véase también setProxy().

void QWebSocketServer::resumeAccepting()

Reanuda la aceptación de nuevas conexiones.

Véase también pauseAccepting().

QWebSocketServer::SslMode QWebSocketServer::secureMode() const

Devuelve el modo seguro en el que se está ejecutando el servidor.

Véase también QWebSocketServer() y SslMode.

QHostAddress QWebSocketServer::serverAddress() const

Devuelve la dirección del servidor si éste está a la escucha de conexiones; en caso contrario devuelve QHostAddress::Null.

Véase también serverPort() y listen().

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

Esta señal se emite cuando se produce un error durante la configuración de una conexión WebSocket. El parámetro closeCode describe el tipo de error que se ha producido.

Véase también errorString().

QString QWebSocketServer::serverName() const

Devuelve el nombre del servidor que se utiliza durante la fase de handshake http.

Véase también setServerName().

quint16 QWebSocketServer::serverPort() const

Devuelve el puerto del servidor si el servidor está escuchando conexiones; en caso contrario devuelve 0.

Véase también serverAddress() y listen().

QUrl QWebSocketServer::serverUrl() const

Devuelve una URL que los clientes pueden utilizar para conectarse a este servidor si el servidor está a la escucha de conexiones. En caso contrario, se devuelve una URL inválida.

Véase también serverPort(), serverAddress(), y listen().

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

Establece el tiempo de espera para nuevas conexiones en msec milisegundos.

Por defecto se establece en 10 segundos. Si un peer utiliza más tiempo para completar el handshake, su conexión se cierra. Puedes pasar un valor negativo (por ejemplo, -1) para desactivar el tiempo de espera.

Véase también handshakeTimeout() y handshakeTimeoutMS().

void QWebSocketServer::setHandshakeTimeout(int msec)

void QWebSocketServer::setMaxPendingConnections(int numConnections)

Establece el número máximo de conexiones pendientes aceptadas en numConnections. WebSocketServer no aceptará más de numConnections conexiones entrantes antes de que se llame a nextPendingConnection(). Por defecto, el límite es de 30 conexiones pendientes.

QWebSocketServer emitirá la señal error() con el código de cierre QWebSocketProtocol::CloseCodeAbnormalDisconnection cuando se haya alcanzado el máximo de conexiones. El handshake WebSocket fallará y el socket se cerrará.

Véase también maxPendingConnections() y hasPendingConnections().

void QWebSocketServer::setProxy(const QNetworkProxy &networkProxy)

Establece el proxy de red explícito para este servidor en networkProxy.

Para desactivar el uso de un proxy, utilice el tipo de proxy QNetworkProxy::NoProxy:

server->setProxy(QNetworkProxy::NoProxy);

Véase también proxy().

void QWebSocketServer::setServerName(const QString &serverName)

Establece el nombre del servidor que se utilizará durante la fase HTTP handshake en la dirección serverName. serverName puede estar vacío, en cuyo caso se enviará al cliente un nombre de servidor vacío. Los clientes ya conectados no serán notificados de este cambio, sólo los clientes recién conectados verán este nuevo nombre.

Véase también serverName().

bool QWebSocketServer::setSocketDescriptor(qintptr socketDescriptor)

Establece el descriptor de socket que este servidor debe usar cuando escucha conexiones entrantes a socketDescriptor.

Devuelve true si el socket se ha configurado correctamente; en caso contrario devuelve false. Se asume que el socket está en estado de escucha.

Véase también socketDescriptor() y isListening().

void QWebSocketServer::setSslConfiguration(const QSslConfiguration &sslConfiguration)

Establece la configuración SSL para QWebSocketServer en sslConfiguration. Este método no tiene efecto si QWebSocketServer se ejecuta en modo no seguro (QWebSocketServer::NonSecureMode).

Véase también sslConfiguration() y SslMode.

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

Establece la lista de protocolos soportados por el servidor en protocols.

Esta función se introdujo en Qt 6.4.

Véase también supportedSubprotocols().

qintptr QWebSocketServer::socketDescriptor() const

Devuelve el descriptor de socket nativo que el servidor usa para escuchar instrucciones entrantes, o -1 si el servidor no está escuchando. Si el servidor está usando QNetworkProxy, el descriptor devuelto puede no ser utilizable con funciones de socket nativas.

Véase también setSocketDescriptor() y isListening().

QSslConfiguration QWebSocketServer::sslConfiguration() const

Devuelve la configuración SSL utilizada por el QWebSocketServer. Si el servidor no se está ejecutando en modo seguro (QWebSocketServer::SecureMode), este método devuelve QSslConfiguration::defaultConfiguration().

Véase también setSslConfiguration(), SslMode, y QSslConfiguration::defaultConfiguration().

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

QWebSocketServer emite esta señal después del handshake SSL para indicar que se han producido uno o más errores mientras se establecía la identidad del peer.

Los errores son normalmente una indicación de que QWebSocketServer es incapaz de identificar de forma segura al peer. A menos que se tome alguna acción, la conexión se interrumpirá después de que se haya emitido esta señal.

errors contiene uno o más errores que impiden a QSslSocket verificar la identidad del par.

Véase también peerVerifyError() y sslErrorsOccurred().

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

QWebSocketServer emite esta señal después del handshake SSL para indicar que se han producido uno o más errores mientras se establecía la identidad del peer.

Los errores son normalmente una indicación de que socket es incapaz de identificar de forma segura al peer. A menos que se tome alguna acción, la conexión se interrumpirá después de que se haya emitido esta señal.

errors contiene uno o más errores que impiden a QSslSocket verificar la identidad del peer.

Si desea continuar la conexión a pesar de los errores que se han producido, debe llamar a QSslSocket::ignoreSslErrors() desde dentro de una ranura conectada a esta señal. Si necesitas acceder a la lista de errores en un momento posterior, puedes llamar a QSslSocket::sslHandshakeErrors().

Esta función se introdujo en Qt 6.11.

Véase también peerVerifyError() y sslErrors().

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

Devuelve la lista de protocolos soportados por el servidor.

Esta función se introdujo en Qt 6.4.

Véase también setSupportedSubprotocols().

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

Devuelve una lista de las versiones de WebSocket que soporta este servidor.