| Home · All Classes · Modules |
The QAbstractSocket class provides the base functionality common to all socket types. More...
Inherits QIODevice.
Inherited by QTcpSocket and QUdpSocket.
The QAbstractSocket class provides the base functionality common to all socket types.
QAbstractSocket is the base class for QTcpSocket and QUdpSocket and contains all common functionality of these two classes. If you need a socket, you have two options:
TCP (Transmission Control Protocol) is a reliable, stream-oriented, connection-oriented transport protocol. UDP (User Datagram Protocol) is an unreliable, datagram-oriented, connectionless protocol. In practice, this means that TCP is better suited for continuous transmission of data, whereas the more lightweight UDP can be used when reliability isn't important.
QAbstractSocket's API unifies most of the differences between the two protocols. For example, although UDP is connectionless, connectToHost() establishes a virtual connection for UDP sockets, enabling you to use QAbstractSocket in more or less the same way regardless of the underlying protocol. Internally, QAbstractSocket remembers the address and port passed to connectToHost(), and functions like read() and write() use these values.
At any time, QAbstractSocket has a state (returned by state()). The initial state is UnconnectedState. After calling connectToHost(), the socket first enters HostLookupState. If the host is found, QAbstractSocket enters ConnectingState and emits the hostFound() signal. When the connection has been established, it enters ConnectedState and emits connected(). If an error occurs at any stage, error() is emitted. Whenever the state changes, stateChanged() is emitted. For convenience, isValid() returns true if the socket is ready for reading and writing, but note that the socket's state must be ConnectedState before reading and writing can occur.
Read or write data by calling read() or write(), or use the convenience functions readLine() and readAll(). QAbstractSocket also inherits getChar(), putChar(), and ungetChar() from QIODevice, which work on single bytes. The bytesWritten() signal is emitted when data has been written to the socket (i.e., when the client has read the data). Note that Qt does not limit the write buffer size. You can monitor its size by listening to this signal.
The readyRead() signal is emitted every time a new chunk of data has arrived. bytesAvailable() then returns the number of bytes that are available for reading. Typically, you would connect the readyRead() signal to a slot and read all available data there. If you don't read all the data at once, the remaining data will still be available later, and any new incoming data will be appended to QAbstractSocket's internal read buffer. To limit the size of the read buffer, call setReadBufferSize().
To close the socket, call disconnectFromHost(). QAbstractSocket enters QAbstractSocket.ClosingState. After all pending data has been written to the socket, QAbstractSocket actually closes the socket, enters QAbstractSocket.ClosedState, and emits disconnected(). If you want to abort a connection immediately, discarding all pending data, call abort() instead. If the remote host closes the connection, QAbstractSocket will emit error(QAbstractSocket.RemoteHostClosedError), during which the socket state will still be ConnectedState, and then the disconnected() signal will be emitted.
The port and address of the connected peer is fetched by calling peerPort() and peerAddress(). peerName() returns the host name of the peer, as passed to connectToHost(). localPort() and localAddress() return the port and address of the local socket.
QAbstractSocket provides a set of functions that suspend the calling thread until certain signals are emitted. These functions can be used to implement blocking sockets:
We show an example:
int numRead = 0, numReadTotal = 0;
char buffer[50];
forever {
numRead = socket.read(buffer, 50);
// do whatever with array
numReadTotal += numRead;
if (numRead == 0 && !socket.waitForReadyRead())
break;
}
If waitForReadyRead() returns false, the connection has been closed or an error has occurred.
Programming with a blocking socket is radically different from programming with a non-blocking socket. A blocking socket doesn't require an event loop and typically leads to simpler code. However, in a GUI application, blocking sockets should only be used in non-GUI threads, to avoid freezing the user interface. See the network/fortuneclient and network/blockingfortuneclient examples for an overview of both approaches.
Note: We discourage the use of the blocking functions together with signals. One of the two possibilities should be used.
QAbstractSocket can be used with QTextStream and QDataStream's stream operators (operator<<() and operator>>()). There is one issue to be aware of, though: You must make sure that enough data is available before attempting to read it using operator>>().
This enum describes the network layer protocol values used in Qt.
| Constant | Value | Description |
|---|---|---|
| QAbstractSocket.IPv4Protocol | 0 | IPv4 |
| QAbstractSocket.IPv6Protocol | 1 | IPv6 |
| QAbstractSocket.UnknownNetworkLayerProtocol | -1 | Other than IPv4 and IPv6 |
See also QHostAddress.protocol().
This enum describes the socket errors that can occur.
| Constant | Value | Description |
|---|---|---|
| QAbstractSocket.ConnectionRefusedError | 0 | The connection was refused by the peer (or timed out). |
| QAbstractSocket.RemoteHostClosedError | 1 | The remote host closed the connection. Note that the client socket (i.e., this socket) will be closed after the remote close notification has been sent. |
| QAbstractSocket.HostNotFoundError | 2 | The host address was not found. |
| QAbstractSocket.SocketAccessError | 3 | The socket operation failed because the application lacked the required privileges. |
| QAbstractSocket.SocketResourceError | 4 | The local system ran out of resources (e.g., too many sockets). |
| QAbstractSocket.SocketTimeoutError | 5 | The socket operation timed out. |
| QAbstractSocket.DatagramTooLargeError | 6 | The datagram was larger than the operating system's limit (which can be as low as 8192 bytes). |
| QAbstractSocket.NetworkError | 7 | An error occurred with the network (e.g., the network cable was accidentally plugged out). |
| QAbstractSocket.AddressInUseError | 8 | The address specified to QUdpSocket.bind() is already in use and was set to be exclusive. |
| QAbstractSocket.SocketAddressNotAvailableError | 9 | The address specified to QUdpSocket.bind() does not belong to the host. |
| QAbstractSocket.UnsupportedSocketOperationError | 10 | The requested socket operation is not supported by the local operating system (e.g., lack of IPv6 support). |
| QAbstractSocket.ProxyAuthenticationRequiredError | 12 | The socket is using a proxy, and the proxy requires authentication. |
| QAbstractSocket.SslHandshakeFailedError | 13 | The SSL/TLS handshake failed, so the connection was closed (only used in QSslSocket) (This value was introduced in 4.4.) |
| QAbstractSocket.UnfinishedSocketOperationError | 11 | Used by QAbstractSocketEngine only, The last operation attempted has not finished yet (still in progress in the background). (This value was introduced in 4.4.) |
| QAbstractSocket.ProxyConnectionRefusedError | 14 | Could not contact the proxy server because the connection to that server was denied (This value was introduced in 4.5.) |
| QAbstractSocket.ProxyConnectionClosedError | 15 | The connection to the proxy server was closed unexpectedly (before the connection to the final peer was established) (This value was introduced in 4.5.) |
| QAbstractSocket.ProxyConnectionTimeoutError | 16 | The connection to the proxy server timed out or the proxy server stopped responding in the authentication phase. (This value was introduced in 4.5.) |
| QAbstractSocket.ProxyNotFoundError | 17 | The proxy address set with setProxy() (or the application proxy) was not found. (This value was introduced in 4.5.) |
| QAbstractSocket.ProxyProtocolError | 18 | The connection negotiation with the proxy server because the response from the proxy server could not be understood. (This value was introduced in 4.5.) |
| QAbstractSocket.UnknownSocketError | -1 | An unidentified error occurred. |
See also QAbstractSocket.error().
This enum represents the options that can be set on a socket. If desired, they can be set after having received the connected() signal from the socket or after having received a new socket from a QTcpServer.
| Constant | Value | Description |
|---|---|---|
| QAbstractSocket.LowDelayOption | 0 | Try to optimize the socket for low latency. For a QTcpSocket this would set the TCP_NODELAY option and disable Nagle's algorithm. Set this to 1 to enable. |
| QAbstractSocket.KeepAliveOption | 1 | Set this to 1 to enable the SO_KEEPALIVE socket option |
| QAbstractSocket.MulticastTtlOption | 2 | Set this to an integer value to set IP_MULTICAST_TTL (TTL for multicast datagrams) socket option. |
| QAbstractSocket.MulticastLoopbackOption | 3 | Set this to 1 to enable the IP_MULTICAST_LOOP (multicast loopback) socket option. |
This enum was introduced or modified in Qt 4.6.
See also QAbstractSocket.setSocketOption() and QAbstractSocket.socketOption().
This enum describes the different states in which a socket can be.
| Constant | Value | Description |
|---|---|---|
| QAbstractSocket.UnconnectedState | 0 | The socket is not connected. |
| QAbstractSocket.HostLookupState | 1 | The socket is performing a host name lookup. |
| QAbstractSocket.ConnectingState | 2 | The socket has started establishing a connection. |
| QAbstractSocket.ConnectedState | 3 | A connection is established. |
| QAbstractSocket.BoundState | 4 | The socket is bound to an address and port (for servers). |
| QAbstractSocket.ClosingState | 6 | The socket is about to close (data may still be waiting to be written). |
| QAbstractSocket.ListeningState | 5 | For internal use only. |
See also QAbstractSocket.state().
This enum describes the transport layer protocol.
| Constant | Value | Description |
|---|---|---|
| QAbstractSocket.TcpSocket | 0 | TCP |
| QAbstractSocket.UdpSocket | 1 | UDP |
| QAbstractSocket.UnknownSocketType | -1 | Other than TCP and UDP |
See also QAbstractSocket.socketType().
The parent argument, if not None, causes self to be owned by Qt instead of PyQt.
Creates a new abstract socket of type socketType. The parent argument is passed to QObject's constructor.
See also socketType(), QTcpSocket, and QUdpSocket.
Aborts the current connection and resets the socket. Unlike disconnectFromHost(), this function immediately closes the socket, discarding any pending data in the write buffer.
See also disconnectFromHost() and close().
Reimplemented from QIODevice.atEnd().
Returns true if no more data is currently available for reading; otherwise returns false.
This function is most commonly used when reading data from the socket in a loop. For example:
// This slot is connected to QAbstractSocket.readyRead() void SocketClass.readyReadSlot() { while (!socket.atEnd()) { QByteArray data = socket.read(100); .... } }
See also bytesAvailable() and readyRead().
Reimplemented from QIODevice.bytesAvailable().
Returns the number of incoming bytes that are waiting to be read.
See also bytesToWrite() and read().
Reimplemented from QIODevice.bytesToWrite().
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 bytesAvailable() and flush().
Reimplemented from QIODevice.canReadLine().
Returns true if a line of data can be read from the socket; otherwise returns false.
See also readLine().
Reimplemented from QIODevice.close().
Closes the I/O device for the socket, disconnects the socket's connection with the host, closes the socket, and resets the name, address, port number and underlying socket descriptor.
See QIODevice.close() for a description of the actions that occur when an I/O device is closed.
See also abort().
Attempts to make a connection to hostName on the given port.
The socket is opened in the given openMode and first enters HostLookupState, then performs a host name lookup of hostName. If the lookup succeeds, hostFound() is emitted and QAbstractSocket enters ConnectingState. It then attempts to connect to the address or addresses returned by the lookup. Finally, if a connection is established, QAbstractSocket enters ConnectedState and emits connected().
At any point, the socket can emit error() to signal that an error occurred.
hostName may be an IP address in string form (e.g., "43.195.83.32"), or it may be a host name (e.g., "example.com"). QAbstractSocket will do a lookup only if required. port is in native byte order.
See also state(), peerName(), peerAddress(), peerPort(), and waitForConnected().
This is an overloaded function.
Attempts to make a connection to address on port port.
This method is also a Qt slot with the C++ signature void connectToHostImplementation(const QString&, ::quint16, ::QIODevice::OpenMode = QIODevice.ReadWrite).
Contains the implementation of connectToHost().
Attempts to make a connection to hostName on the given port. The socket is opened in the given openMode.
This function was introduced in Qt 4.1.
Attempts to close the socket. If there is pending data waiting to be written, QAbstractSocket will enter ClosingState and wait until all data has been written. Eventually, it will enter UnconnectedState and emit the disconnected() signal.
See also connectToHost().
This method is also a Qt slot with the C++ signature void disconnectFromHostImplementation().
Contains the implementation of disconnectFromHost().
This function was introduced in Qt 4.1.
Returns the type of error that last occurred.
See also state() and errorString().
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 QAbstractSocket 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 QAbstractSocket will start sending data automatically once control goes back to the event loop. In the absence of an event loop, call waitForBytesWritten() instead.
See also write() and waitForBytesWritten().
Reimplemented from QIODevice.isSequential().
Returns true if the socket is valid and ready for use; otherwise returns false.
Note: The socket's state must be ConnectedState before reading and writing can occur.
See also state().
Returns the host address of the local socket if available; otherwise returns QHostAddress.Null.
This is normally the main IP address of the host, but can be QHostAddress.LocalHost (127.0.0.1) for connections to the local host.
See also localPort(), peerAddress(), and setLocalAddress().
Returns the host port number (in native byte order) of the local socket if available; otherwise returns 0.
See also localAddress(), peerPort(), and setLocalPort().
Returns the address of the connected peer if the socket is in ConnectedState; otherwise returns QHostAddress.Null.
See also peerName(), peerPort(), localAddress(), and setPeerAddress().
Returns the name of the peer as specified by connectToHost(), or an empty QString if connectToHost() has not been called.
See also peerAddress(), peerPort(), and setPeerName().
Returns the port of the connected peer if the socket is in ConnectedState; otherwise returns 0.
See also peerAddress(), localPort(), and setPeerPort().
Returns the network proxy for this socket. By default QNetworkProxy.DefaultProxy is used, which means this socket will query the default proxy settings for the application.
This function was introduced in Qt 4.1.
See also setProxy(), QNetworkProxy, and QNetworkProxyFactory.
Returns the size of the internal read buffer. This limits the amount of data that the client can receive before you call read() or readAll().
A read buffer size of 0 (the default) means that the buffer has no size limit, ensuring that no data is lost.
See also setReadBufferSize() and read().
Reimplemented from QIODevice.readData().
Reimplemented from QIODevice.readLineData().
Sets the address on the local side of a connection to address.
You can call this function in a subclass of QAbstractSocket to change the return value of the localAddress() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.
Note that this function does not bind the local address of the socket prior to a connection (e.g., QUdpSocket.bind()).
This function was introduced in Qt 4.1.
See also localAddress(), setLocalPort(), and setPeerAddress().
Sets the port on the local side of a connection to port.
You can call this function in a subclass of QAbstractSocket to change the return value of the localPort() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.
Note that this function does not bind the local port of the socket prior to a connection (e.g., QUdpSocket.bind()).
This function was introduced in Qt 4.1.
See also localPort(), localAddress(), setLocalAddress(), and setPeerPort().
Sets the address of the remote side of the connection to address.
You can call this function in a subclass of QAbstractSocket to change the return value of the peerAddress() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.
This function was introduced in Qt 4.1.
See also peerAddress(), setPeerPort(), and setLocalAddress().
Sets the host name of the remote peer to name.
You can call this function in a subclass of QAbstractSocket to change the return value of the peerName() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.
This function was introduced in Qt 4.1.
See also peerName().
Sets the port of the remote side of the connection to port.
You can call this function in a subclass of QAbstractSocket to change the return value of the peerPort() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.
This function was introduced in Qt 4.1.
See also peerPort(), setPeerAddress(), and setLocalPort().
Sets the explicit network proxy for this socket to networkProxy.
To disable the use of a proxy for this socket, use the QNetworkProxy.NoProxy proxy type:
socket->setProxy(QNetworkProxy.NoProxy);
The default value for the proxy is QNetworkProxy.DefaultProxy, which means the socket will use the application settings: if a proxy is set with QNetworkProxy.setApplicationProxy, it will use that; otherwise, if a factory is set with QNetworkProxyFactory.setApplicationProxyFactory, it will query that factory with type QNetworkProxyQuery.TcpSocket.
This function was introduced in Qt 4.1.
See also proxy(), QNetworkProxy, and QNetworkProxyFactory.queryProxy().
Sets the size of QAbstractSocket's internal read buffer to be size bytes.
If the buffer size is limited to a certain size, QAbstractSocket won't buffer more than this size of data. Exceptionally, a buffer size of 0 means that the read buffer is unlimited and all incoming data is buffered. This is the default.
This option is useful if you only read the data at certain points in time (e.g., in a real-time streaming application) or if you want to protect your socket against receiving too much data, which may eventually cause your application to run out of memory.
Only QTcpSocket uses QAbstractSocket's internal buffer; QUdpSocket does not use any buffering at all, but rather relies on the implicit buffering provided by the operating system. Because of this, calling this function on QUdpSocket has no effect.
See also readBufferSize() and read().
Initializes QAbstractSocket with the native socket descriptor socketDescriptor. Returns true if socketDescriptor is accepted as a valid socket descriptor; otherwise returns false. The socket is opened in the mode specified by openMode, and enters the socket state specified by socketState.
Note: It is not possible to initialize two abstract sockets with the same native socket descriptor.
See also socketDescriptor().
Sets the type of error that last occurred to socketError.
See also setSocketState() and setErrorString().
Sets the given option to the value described by value.
This function was introduced in Qt 4.6.
See also socketOption().
Sets the state of the socket to state.
See also state().
Returns the native socket descriptor of the QAbstractSocket object if this is available; otherwise returns -1.
If the socket is using QNetworkProxy, the returned descriptor may not be usable with native socket functions.
The socket descriptor is not available when QAbstractSocket is in UnconnectedState.
See also setSocketDescriptor().
Returns the value of the option option.
This function was introduced in Qt 4.6.
See also setSocketOption().
Returns the socket type (TCP, UDP, or other).
See also QTcpSocket and QUdpSocket.
Returns the state of the socket.
See also error().
Reimplemented from QIODevice.waitForBytesWritten().
Waits until the socket is connected, up to msecs milliseconds. If the connection has been established, this function returns true; otherwise it returns false. In the case where it returns false, you can call error() to determine the cause of the error.
The following example waits up to one second for a connection to be established:
socket->connectToHost("imap", 143); if (socket->waitForConnected(1000)) qDebug("Connected!");
If msecs is -1, this function will not time out.
Note: This function may wait slightly longer than msecs, depending on the time it takes to complete the host lookup.
Note: Multiple calls to this functions do not accumulate the time. If the function times out, the connecting process will be aborted.
See also connectToHost() and connected().
Waits until the socket has disconnected, up to msecs milliseconds. If the connection has been disconnected, this function returns true; otherwise it returns false. In the case where it returns false, you can call error() to determine the cause of the error.
The following example waits up to one second for a connection to be closed:
socket->disconnectFromHost(); if (socket->state() == QAbstractSocket.UnconnectedState || socket->waitForDisconnected(1000)) qDebug("Disconnected!");
If msecs is -1, this function will not time out.
See also disconnectFromHost() and close().
Reimplemented from QIODevice.waitForReadyRead().
This function blocks until new data is available for reading and the readyRead() signal has been emitted. The function will timeout after msecs milliseconds; the default timeout is 30000 milliseconds.
The function returns true if the readyRead() signal is emitted and there is new data available for reading; otherwise it returns false (if an error occurred or the operation timed out).
See also waitForBytesWritten().
Reimplemented from QIODevice.writeData().
This is the default overload of this signal.
This signal is emitted after connectToHost() has been called and a connection has been successfully established.
Note: On some operating systems the connected() signal may be directly emitted from the connectToHost() call for connections to the localhost.
See also connectToHost() and disconnected().
This is the default overload of this signal.
This signal is emitted when the socket has been disconnected.
Warning: If you need to delete the sender() of this signal in a slot connected to it, use the deleteLater() function.
See also connectToHost(), disconnectFromHost(), and abort().
This is the default overload of this signal.
This signal is emitted after an error occurred. The socketError parameter describes the type of error that occurred.
QAbstractSocket.SocketError is not a registered metatype, so for queued connections, you will have to register it with Q_DECLARE_METATYPE() and qRegisterMetaType().
See also error(), errorString(), and Creating Custom Qt Types.
This is the default overload of this signal.
This signal is emitted after connectToHost() has been called and the host lookup has succeeded.
Note: Since Qt 4.6.3 QAbstractSocket may emit hostFound() directly from the connectToHost() call since a DNS result could have been cached.
See also connected().
This is the default overload of this signal.
This signal can be emitted when a proxy that requires authentication is used. The authenticator object can then be filled in with the required details to allow authentication and continue the connection.
Note: It is not possible to use a QueuedConnection to connect to this signal, as the connection will fail if the authenticator has not been filled in with new information when the signal returns.
This function was introduced in Qt 4.3.
See also QAuthenticator and QNetworkProxy.
This is the default overload of this signal.
This signal is emitted whenever QAbstractSocket's state changes. The socketState parameter is the new state.
QAbstractSocket.SocketState is not a registered metatype, so for queued connections, you will have to register it with Q_REGISTER_METATYPE() and qRegisterMetaType().
See also state() and Creating Custom Qt Types.
| PyQt 4.12.1 for X11 | Copyright © Riverbank Computing Ltd and The Qt Company 2015 | Qt 4.8.7 |