QSocketNotifier

The QSocketNotifier class provides support for monitoring activity on a file descriptor. More

Inheritance diagram of PySide2.QtCore.QSocketNotifier

Synopsis

Functions

Slots

Detailed Description

The QSocketNotifier makes it possible to integrate Qt’s event loop with other event loops based on file descriptors. File descriptor action is detected in Qt’s main event loop ( exec() ).

Once you have opened a device using a low-level (usually platform-specific) API, you can create a socket notifier to monitor the file descriptor. The socket notifier is enabled by default, i.e. it emits the activated() signal whenever a socket event corresponding to its type occurs. Connect the activated() signal to the slot you want to be called when an event corresponding to your socket notifier’s type occurs.

There are three types of socket notifiers: read, write, and exception. The type is described by the Type enum, and must be specified when constructing the socket notifier. After construction it can be determined using the type() function. Note that if you need to monitor both reads and writes for the same file descriptor, you must create two socket notifiers. Note also that it is not possible to install two socket notifiers of the same type ( Read , Write , Exception ) on the same socket.

The setEnabled() function allows you to disable as well as enable the socket notifier. It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers. A disabled notifier ignores socket events (the same effect as not creating the socket notifier). Use the isEnabled() function to determine the notifier’s current status.

Finally, you can use the socket() function to retrieve the socket identifier. Although the class is called QSocketNotifier , it is normally used for other types of devices than sockets. QTcpSocket and QUdpSocket provide notification through signals, so there is normally no need to use a QSocketNotifier on them.

See also

QFile QProcess QTcpSocket QUdpSocket

class PySide2.QtCore.QSocketNotifier(arg__1, arg__2[, parent=None])

PySide2.QtCore.QSocketNotifier(socket, arg__2[, parent=None])

param parent

PySide2.QtCore.QObject

param arg__1

object

param socket

qintptr

param arg__2

Type

Constructs a socket notifier with the given parent . It enables the socket , and watches for events of the given type .

It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers.

Note for Windows users: The socket passed to QSocketNotifier will become non-blocking, even if it was created as a blocking socket.

PySide2.QtCore.QSocketNotifier.Type

This enum describes the various types of events that a socket notifier can recognize. The type must be specified when constructing the socket notifier.

Note that if you need to monitor both reads and writes for the same file descriptor, you must create two socket notifiers. Note also that it is not possible to install two socket notifiers of the same type (Read, Write, Exception) on the same socket.

Constant

Description

QSocketNotifier.Read

There is data to be read.

QSocketNotifier.Write

Data can be written.

QSocketNotifier.Exception

An exception has occurred. We recommend against using this.

See also

QSocketNotifier() type()

PySide2.QtCore.QSocketNotifier.isEnabled()
Return type

bool

Returns true if the notifier is enabled; otherwise returns false .

See also

setEnabled()

PySide2.QtCore.QSocketNotifier.setEnabled(arg__1)
Parameters

arg__1 – bool

If enable is true, the notifier is enabled; otherwise the notifier is disabled.

The notifier is enabled by default, i.e. it emits the activated() signal whenever a socket event corresponding to its type occurs. If it is disabled, it ignores socket events (the same effect as not creating the socket notifier).

Write notifiers should normally be disabled immediately after the activated() signal has been emitted

See also

isEnabled() activated()

PySide2.QtCore.QSocketNotifier.socket()
Return type

qintptr

Returns the socket identifier specified to the constructor.

See also

type()

PySide2.QtCore.QSocketNotifier.type()
Return type

Type

Returns the socket event type specified to the constructor.

See also

socket()