QWebSocket¶

Implements a TCP socket that talks the WebSocket protocol. More…

Synopsis¶

Functions¶

def abort ()
def bytesToWrite ()
def closeCode ()
def closeReason ()
def continueInterruptedHandshake ()
def error ()
def errorString ()
def flush ()
def ignoreSslErrors (errors)
def isValid ()
def localAddress ()
def localPort ()
def maskGenerator ()
def maxAllowedIncomingFrameSize ()
def maxAllowedIncomingMessageSize ()
def origin ()
def outgoingFrameSize ()
def pauseMode ()
def peerAddress ()
def peerName ()
def peerPort ()
def proxy ()
def readBufferSize ()
def request ()
def requestUrl ()
def resourceName ()
def resume ()
def sendBinaryMessage (data)
def sendTextMessage (message)
def setMaskGenerator (maskGenerator)
def setMaxAllowedIncomingFrameSize (maxAllowedIncomingFrameSize)
def setMaxAllowedIncomingMessageSize (maxAllowedIncomingMessageSize)
def setOutgoingFrameSize (outgoingFrameSize)
def setPauseMode (pauseMode)
def setProxy (networkProxy)
def setReadBufferSize (size)
def setSslConfiguration (sslConfiguration)
def sslConfiguration ()
def state ()
def version ()

Slots¶

def close ([closeCode=QWebSocketProtocol.CloseCodeNormal[, reason=””]])
def ignoreSslErrors ()
def open (request)
def open (url)
def ping ([payload=QByteArray()])

Signals¶

def aboutToClose ()
def alertReceived (level, type, description)
def alertSent (level, type, description)
def binaryFrameReceived (frame, isLastFrame)
def binaryMessageReceived (message)
def bytesWritten (bytes)
def connected ()
def disconnected ()
def error (error)
def handshakeInterruptedOnError (error)
def peerVerifyError (error)
def pong (elapsedTime, payload)
def preSharedKeyAuthenticationRequired (authenticator)
def proxyAuthenticationRequired (proxy, pAuthenticator)
def readChannelFinished ()
def sslErrors (errors)
def stateChanged (state)
def textFrameReceived (frame, isLastFrame)
def textMessageReceived (message)

Detailed Description¶

WebSockets is a web technology providing full-duplex communications channels over a single TCP connection. The WebSocket protocol was standardized by the IETF as RFC 6455 in 2011. QWebSocket can both be used in a client application and server application.

This class was modeled after QAbstractSocket .

QWebSocket currently does not support WebSocket Extensions and WebSocket Subprotocols .

QWebSocket only supports version 13 of the WebSocket protocol, as outlined in RFC 6455 .

Note

Some proxies do not understand certain HTTP headers used during a WebSocket handshake. In that case, non-secure WebSocket connections fail. The best way to mitigate against this problem is to use WebSocket over a secure connection.

Warning

To generate masks, this implementation of WebSockets uses the reasonably secure global() ->generate() function. For more information about the importance of good masking, see “Talking to Yourself for Fun and Profit” by Lin-Shung Huang et al . The best measure against attacks mentioned in the document above, is to use QWebSocket over a secure connection (wss://). In general, always be careful to not have 3rd party script access to a QWebSocket in your application.

See also

QAbstractSocket QTcpSocket QWebSocket client example

class PySide6.QtWebSockets.QWebSocket([origin=""[, version=QWebSocketProtocol.VersionLatest[, parent=None]]])¶

Parameters

version – Version
origin – str
parent – PySide6.QtCore.QObject

Creates a new QWebSocket with the given origin, the version of the protocol to use and parent.

The origin of the client is as specified in RFC 6454 . (The origin is not required for non-web browser clients (see RFC 6455 )). The origin may not contain new line characters, otherwise the connection will be aborted immediately during the handshake phase.

Note

Currently only V13 ( RFC 6455 ) is supported

PySide6.QtWebSockets.QWebSocket.abort()¶

Aborts the current socket and resets the socket. Unlike close() , this function immediately closes the socket, discarding any pending data in the write buffer.

PySide6.QtWebSockets.QWebSocket.aboutToClose()¶

PySide6.QtWebSockets.QWebSocket.alertReceived(level, type, description)¶

Parameters

level – AlertLevel
type – AlertType
description – str

PySide6.QtWebSockets.QWebSocket.alertSent(level, type, description)¶

Parameters

level – AlertLevel
type – AlertType
description – str

PySide6.QtWebSockets.QWebSocket.binaryFrameReceived(frame, isLastFrame)¶

Parameters

frame – PySide6.QtCore.QByteArray
isLastFrame – bool

PySide6.QtWebSockets.QWebSocket.binaryMessageReceived(message)¶

Parameters: message – PySide6.QtCore.QByteArray

PySide6.QtWebSockets.QWebSocket.bytesToWrite()¶

Return type: int

Returns the number of bytes that are waiting to be written. The bytes are written when control goes back to the event loop or when flush() is called.

See also

flush

PySide6.QtWebSockets.QWebSocket.bytesWritten(bytes)¶

Parameters: bytes – int

PySide6.QtWebSockets.QWebSocket.close([closeCode=QWebSocketProtocol.CloseCodeNormal[, reason=""]])¶

Parameters

closeCode – CloseCode
reason – str

Gracefully closes the socket with the given closeCode and reason.

Any data in the write buffer is flushed before the socket is closed. The closeCode is a CloseCode indicating the reason to close, and reason describes the reason of the closure more in detail. All control frames, including the Close frame, are limited to 125 bytes. Since two of these are used for closeCode the maximum length of reason is 123! If reason exceeds this limit it will be truncated.

PySide6.QtWebSockets.QWebSocket.closeCode()¶

Return type: CloseCode

Returns the code indicating why the socket was closed.

See also

CloseCode closeReason()

PySide6.QtWebSockets.QWebSocket.closeReason()¶

Return type: str

Returns the reason why the socket was closed.

See also

closeCode()

PySide6.QtWebSockets.QWebSocket.connected()¶

PySide6.QtWebSockets.QWebSocket.continueInterruptedHandshake()¶

If an application wants to conclude a handshake even after receiving handshakeInterruptedOnError() signal, it must call this function. This call must be done from a slot function attached to the signal. The signal-slot connection must be direct.

See also

handshakeInterruptedOnError() setHandshakeMustInterruptOnError()

PySide6.QtWebSockets.QWebSocket.disconnected()¶

PySide6.QtWebSockets.QWebSocket.error()¶

Return type: SocketError

Returns the type of error that last occurred

See also

errorString()

PySide6.QtWebSockets.QWebSocket.error(error)

Parameters: error – SocketError

PySide6.QtWebSockets.QWebSocket.errorString()¶

Return type: str

Returns a human-readable description of the last error that occurred

See also

error()

PySide6.QtWebSockets.QWebSocket.flush()¶

Return type: bool

This function writes as much as possible from the internal write buffer to the underlying network socket, without blocking. If any data was written, this function returns true; otherwise false is returned. Call this function if you need QWebSocket to start sending buffered data immediately. The number of bytes successfully written depends on the operating system. In most cases, you do not need to call this function, because QWebSocket will start sending data automatically once control goes back to the event loop.

PySide6.QtWebSockets.QWebSocket.handshakeInterruptedOnError(error)¶

Parameters: error – PySide6.QtNetwork.QSslError

PySide6.QtWebSockets.QWebSocket.ignoreSslErrors(errors)¶

Parameters: errors –

This is an overloaded function.

This method tells QWebSocket to ignore the errors given in errors.

Note that you can set the expected certificate in the SSL error: If, for instance, you want to connect to a server that uses a self-signed certificate, consider the following snippet:

cert = QSslCertificate.fromPath("server-certificate.pem")
error = QSslError(QSslError.SelfSignedCertificate, cert.at(0))
expectedSslErrors = QList()
expectedSslErrors.append(error)
socket = QWebSocket()
socket.ignoreSslErrors(expectedSslErrors)
socket.open(QUrl(QStringLiteral("wss://myserver.at.home")))

Multiple calls to this function will replace the list of errors that were passed in previous calls. You can clear the list of errors you want to ignore by calling this function with an empty list.

See also

sslErrors()

PySide6.QtWebSockets.QWebSocket.ignoreSslErrors()

This slot tells QWebSocket to ignore errors during QWebSocket ‘s handshake phase and continue connecting. If you want to continue with the connection even if errors occur during the handshake phase, then you must call this slot, either from a slot connected to sslErrors() , or before the handshake phase. If you don’t call this slot, either in response to errors or before the handshake, the connection will be dropped after the sslErrors() signal has been emitted.

Warning

Be sure to always let the user inspect the errors reported by the sslErrors() signal, and only call this method upon confirmation from the user that proceeding is ok. If there are unexpected errors, the connection should be aborted. Calling this method without inspecting the actual errors will most likely pose a security risk for your application. Use it with great care!

Table of Contents

Previous topic

Next topic

QWebSocket¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Static functions¶

Detailed Description¶