QSocketNotifier Class Reference

The QSocketNotifier class provides support for socket callbacks. More...

#include <qsocketnotifier.h>

Inherits QObject.

List of all member functions.

Public Members

enum Type { Read, Write, Exception }
QSocketNotifier ( int socket, Type type, QObject * parent = 0, const char * name = 0 )
~QSocketNotifier ()
int socket () const
Type type () const
bool isEnabled () const
virtual void setEnabled ( bool enable )

Signals

void activated ( int socket )

Detailed Description

The QSocketNotifier class provides support for socket callbacks.

This class makes it possible to write asynchronous socket-based code in Qt. Using synchronous socket operations blocks the program, which is clearly not acceptable for an event-driven GUI program.

Once you have opened a non-blocking socket (whether for TCP, UDP, a UNIX-domain socket, or any other protocol family your operating system supports), you can create a socket notifier to monitor the socket. Then you connect the activated() signal to the slot you want to be called when a socket event occurs.

There are three types of socket notifiers (read, write and exception); you must specify one of these in the constructor.

The type specifies when the activated() signal is to be emitted:

QSocketNotifier::Read - There is data to be read (socket read event).
QSocketNotifier::Write - Data can be written (socket write event).
QSocketNofifier::Exception - An exception has occurred (socket exception event). We recommend against using this.

For example, if you need to monitor both reads and writes for the same socket you must create two socket notifiers.

Example:

        int sockfd;                                 // socket identifier
        struct sockaddr_in sa;                      // should contain host address
        sockfd = socket( AF_INET, SOCK_STREAM, 0 ); // create TCP socket
        // make the socket non-blocking here, usually using fcntl( O_NONBLOCK )
        ::connect( sockfd, (struct sockaddr*)&sa,   // connect to host
                   sizeof(sa) );                    // NOT QObject::connect()!
        QSocketNotifier *sn;
        sn = new QSocketNotifier( sockfd, QSocketNotifier::Read, parent );
        QObject::connect( sn, SIGNAL(activated(int)),
                          myObject, SLOT(dataReceived()) );

The optional parent argument can be set to make the socket notifier a child of any QObject, e.g. a widget. This will ensure that it is automatically destroyed when the widget is destroyed.

For read notifiers it makes little sense to connect the activated() signal to more than one slot because the data can be read from the socket only once.

Also observe that if you do not read all the available data when the read notifier fires, it fires again and again.

If you disable the read notifier your program may deadlock. (The same applies to exception notifiers if you must use them, for instance if you must use TCP urgent data.)

For write notifiers, immediately disable the notifier after the activated() signal has been received and you have sent the data to be written on the socket. When you have more data to be written, enable it again to get a new activated() signal. The exception is if the socket data writing operation (send() or equivalent) fails with a "would block" error, which means that some buffer is full and you must wait before sending more data. In that case you do not need to disable and re-enable the write notifier; it will fire again as soon as the system allows more data to be sent.

The behavior of a write notifier that is left in enabled state after having emitting the first activated() signal (and no "would block" error has occurred) is undefined. Depending on the operating system, it may fire on every pass of the event loop or not at all.

If you need a time-out for your sockets you can use either timer events or the QTimer class.

Socket action is detected in the main event loop of Qt. The X11 version of Qt has a single UNIX select() call that incorporates all socket notifiers and the X socket.

Note that on XFree86 for OS/2, select() works only in the thread in which main() is running; you should therefore use that thread for GUI operations.

Member Type Documentation

QSocketNotifier::Type

QSocketNotifier::Read
QSocketNotifier::Write
QSocketNotifier::Exception

Member Function Documentation

QSocketNotifier::QSocketNotifier ( int socket, Type type, QObject * parent = 0, const char * name = 0 )

Constructs a socket notifier called name, with the parent, parent. It watches socket for type events, and enables it.

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

QSocketNotifier::~QSocketNotifier ()

Destroys the socket notifier.

void QSocketNotifier::activated ( int socket ) `[signal]`

This signal is emitted under certain conditions specified by the notifier type():

QSocketNotifier::Read - There is data to be read (socket read event).
QSocketNotifier::Write - Data can be written (socket write event).
QSocketNofifier::Exception - An exception has occurred (socket exception event).

The socket argument is the socket identifier.

bool QSocketNotifier::isEnabled () const

Returns TRUE if the notifier is enabled; otherwise returns FALSE.

void QSocketNotifier::setEnabled ( bool enable ) `[virtual]`

Enables the notifier if enable is TRUE or disables it if enable is FALSE.

The notifier is enabled by default.

If the notifier is enabled, 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 discussion of write notifiers in the class description above.

int QSocketNotifier::socket () const

Returns the socket identifier specified to the constructor.

Type QSocketNotifier::type () const

Returns the socket event type specified to the constructor: QSocketNotifier::Read, QSocketNotifier::Write, or QSocketNotifier::Exception.