Typedef for QFlags<BindFlag> which contains an OR combination of BindFlag values.

Refer to QAbstractSocket::BindFlag for the enum documentation.

Typedef for QFlags<PauseMode> which contains an OR combination of PauseMode values.

Refer to QAbstractSocket::PauseMode for the enum documentation.

This enum describes the different flags you can pass to modify the behavior of QAbstractSocket::bind().

This enum describes the network layer protocol values.

See also

QHostAddress::protocol()

This enum describes the behavior of when the socket should hold back with continuing data transfer. The only notification currently supported is QSslSocket::sslErrors().

This enum describes the socket errors that can occur.

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.

See also

QAbstractSocket::setSocketOption(), QAbstractSocket::socketOption()

This enum describes the different states in which a socket can be.

See also

QAbstractSocket::state()

This enum describes the transport layer protocol.

See also

QAbstractSocket::socketType()

Creates a new abstract socket of type socketType. The parent object is passed to the QObject constructor.

See also

socketType(), QTcpSocket, QUdpSocket

Destroys the socket.

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

See also

disconnectFromHost(), close()

Returns true if no more data is currently available for reading, otherwise returns false. This method is most commonly used when reading data from the socket in a loop.

See also

bytesAvailable(), readyRead()

Reimplemented from QIODevice::atEnd()

Reimplemented in QSslSocket::atEnd()

Binds to address on port using the given mode. By default the socket is bound using the value DefaultForPlatform in the enum BindMode. If a port is not specified a random port is chosen. On success this method returns true and the socket enters the value BoundState in the enum SocketState, otherwise it returns false.

For UDP sockets, after binding, the signal QUdpSocket::readyRead() is emitted whenever a UDP datagram arrives on the specified address and port. For TCP sockets, this method may be used to specify which interface to use for an outgoing connection, which is useful in case of multiple network interfaces.

Binds to QHostAddress:Any on port using the given mode. By default the socket is bound using the DefaultForPlatform in the enum BindMode. If a port is not specified a random port is chosen.

Returns the number of incoming bytes that are waiting to be read.

See also

bytesToWrite(), read()

Reimplemented from QIODevice::bytesAvailable()

Reimplemented in QSslSocket::bytesAvailable()

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(), flush()

Reimplemented from QIODevice::bytesToWrite()

Reimplemented in QSslSocket::bytesToWrite()

Returns true if a line of data can be read from the socket, otherwise returns false.

See also

readLine()

Reimplemented from QIODevice::canReadLine()

Reimplemented in QSslSocket::canReadLine()

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.

Refer to QIODevice::close() for a description of the actions that occur when an I/O device is closed.

See also

abort()

Reimplemented from QIODevice::close()

Reimplemented in QSslSocket::close()

This signal is emitted after connectToHost() has been called and a connection has been successfully established.

On some operating systems the connected() signal may be directly emitted from the connectToHost() call for connections to the localhost.

See also

connectToHost(), disconnected()

Attempts to make a connection to address on the given port.

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.

The parameter hostName can be an IP address like "127.0.0.1" or it can be a host name like "example.com". QAbstractSocket will do a lookup only if required. The port is in native byte order.

See also

state(), peerName(), peerAddress(), peerPort(), waitForConnected()

Reimplemented in QSslSocket::connectToHost()

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() method.

See also

connectToHost(), disconnectFromHost(), abort()

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()

Reimplemented in QSslSocket::disconnectFromHost()

Returns the type of error that last occurred.

See also

state(), errorString()

This signal is emitted after an error occurred. The socketError parameter describes the type of error that occurred.

See also

error(), errorString(), Creating Custom Types

This method writes as much as possible from the internal write buffer to the underlying network socket, without blocking. If any data was written, this method returns true, otherwise false is returned.

Call this method 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 method, 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(), waitForBytesWritten()

This signal is emitted after connectToHost() has been called and the host lookup has succeeded.

Note

QAbstractSocket may emit hostFound() directly from the connectToHost() call since a DNS result could have been cached.

See also

connected()

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(), setLocalAddress()

Returns the host port number (in native byte order) of the local socket if available, otherwise returns 0.

See also

localAddress(), peerPort(), setLocalPort()

Returns the pause mode of this socket.

See also

setPauseMode(), resume()

Returns the address of the connected peer if the socket is in ConnectedState, otherwise returns QHostAddress::Null.

See also

peerName(), peerPort(), localAddress(), 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(), setPeerName()

Returns the port of the connected peer if the socket is in ConnectedState, otherwise returns 0.

See also

peerAddress(), localPort(), 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.

See also

setProxy(), QNetworkProxy, QNetworkProxyFactory

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.

See also

QAuthenticator, QNetworkProxy

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(), read()

Implements QIODevice::readData()

Reimplemented in QSslSocket::readData()

Reimplemented from QIODevice::readLineData()

Continues data transfer on the socket. This method should only be used after the socket has been set to pause upon notifications and a notification has been received. The only notification currently supported is QSslSocket::sslErrors(). Calling this method if the socket is not paused results in undefined behavior.

See also

pauseMode(), setPauseMode()

Reimplemented in QSslSocket::resume()

Sets the address on the local side of a connection to address.

You can call this method in a subclass of QAbstractSocket to change the return value of the localAddress() method after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.

This method does not bind the local address of the socket prior to a connection (e.g., QUdpSocket::bind()).

See also

localAddress(), setLocalPort(), setPeerAddress()

Sets the port on the local side of a connection to port.

You can call this method in a subclass of QAbstractSocket to change the return value of the localPort() method after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.

Note that this method does not bind the local port of the socket prior to a connection (e.g., QUdpSocket::bind()).

See also

localPort(), localAddress(), setLocalAddress(), setPeerPort()

Controls whether to pause upon receiving a notification. The pauseMode parameter specifies the conditions in which the socket should be paused. The only notification currently supported is QSslSocket::sslErrors(). If set to PauseOnSslErrors, data transfer on the socket will be paused and needs to be enabled explicitly again by calling resume(). By default this option is set to PauseNever. This option must be called before connecting to the server, otherwise it will result in undefined behavior.

See also

pauseMode(), resume()

Sets the address of the remote side of the connection to address.

You can call this method in a subclass of QAbstractSocket to change the return value of the peerAddress() method after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.

See also

peerAddress(), setPeerPort(), setLocalAddress()

Sets the host name of the remote peer to name.

You can call this method in a subclass of QAbstractSocket to change the return value of the peerName() method after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.

See also

peerName()

Sets the port of the remote side of the connection to port.

You can call this method in a subclass of QAbstractSocket to change the return value of the peerPort() method after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.

See also

peerPort(), setPeerAddress(), 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:

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.

See also

proxy(), QNetworkProxy, 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 will not 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 method on QUdpSocket has no effect.

See also

readBufferSize(), read()

Reimplemented in QSslSocket::setReadBufferSize()

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()

Reimplemented in QSslSocket::setSocketDescriptor()

Sets the type of error that last occurred to socketError.

See also

setSocketState(), setErrorString()

Sets the given option to the value described by value.

See also

socketOption()

Reimplemented in QSslSocket::setSocketOption()

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 option.

See also

setSocketOption()

Reimplemented in QSslSocket::socketOption()

Returns the socket type (TCP, UDP, or other).

See also

QTcpSocket, QUdpSocket

Returns the state of the socket.

See also

error()

This signal is emitted whenever QAbstractSocket's state changes. The socketState parameter is the new state.

See also

state(), Creating Custom Types

Reimplemented from QIODevice::waitForBytesWritten()

Reimplemented in QSslSocket::waitForBytesWritten()

Waits until the socket is connected, up to msecs milliseconds. If the connection has been established, this method 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:

If msecs is -1, this method will not time out.

Note

This method may wait slightly longer than msecs, depending on the time it takes to complete the host lookup.

Multiple calls to this functions do not accumulate the time. If the method times out, the connecting process will be aborted.

See also

connectToHost(), connected()

Reimplemented in QSslSocket::waitForConnected()

Waits until the socket has disconnected, up to msecs milliseconds. If the connection has been disconnected, this method 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:

If msecs is -1, this method will not time out.

See also

disconnectFromHost(), close()

Reimplemented in QSslSocket::waitForDisconnected()

This method blocks until new data is available for reading and the readyRead() signal has been emitted. The method will timeout after msecs milliseconds; the default timeout is 30000 milliseconds.

The method 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::waitForReadyRead()

Reimplemented in QSslSocket::waitForReadyRead()

Implements QIODevice::writeData()

Reimplemented in QSslSocket::writeData()