QAbstractSocketPrivate Class Reference

#include <qabstractsocket_p.h>

Inheritance diagram for QAbstractSocketPrivate:

Public Functions
void	_q_abortConnectionAttempt ()
	This function is called after a certain number of seconds has passed while waiting for a connection. More...
void	_q_connectToNextAddress ()
	Called by a queued or direct connection from _q_startConnecting() or _q_testConnection(), this function takes the first address of the pending addresses list and tries to connect to it. More...
void	_q_forceDisconnect ()
void	_q_startConnecting (const QHostInfo &hostInfo)
	Slot connected to QHostInfo::lookupHost() in connectToHost(). More...
void	_q_testConnection ()
	Tests if a connection has been established. More...
bool	canReadNotification ()
	Slot connected to the read socket notifier. More...
bool	canWriteNotification ()
	Slot connected to the write socket notifier. More...
void	connectionNotification ()
	Slot connected to a notification of connection status change. More...
void	exceptionNotification ()
void	fetchConnectionParameters ()
	Sets up the internal state after the connection has succeeded. More...
bool	flush ()
	Writes pending data in the write buffers to the socket. More...
bool	initSocketLayer (QAbstractSocket::NetworkLayerProtocol protocol)
	Initializes the socket layer to by of type type, using the network layer protocol protocol. More...
void	proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator)
	QAbstractSocketPrivate ()
	Constructs a QAbstractSocketPrivate. More...
bool	readFromSocket ()
	Reads data from the socket layer into the read buffer. More...
void	readNotification ()
void	resetSocketLayer ()
	Resets the socket layer, clears the read and write buffers and deletes any socket notifiers. More...
void	resolveProxy (const QString &hostName, quint16 port)
	Resolve the proxy to its final value. More...
void	resolveProxy (quint16 port)
void	setupSocketNotifiers ()
void	startConnectingByName (const QString &host)
	Starts the connection to host, like _q_startConnecting below, but without hostname resolution. More...
void	writeNotification ()
virtual	~QAbstractSocketPrivate ()
	Destructs the QAbstractSocket. More...
Public Functions inherited from QIODevicePrivate
bool	isSequential () const
virtual qint64	peek (char *data, qint64 maxSize)
virtual QByteArray	peek (qint64 maxSize)
virtual bool	putCharHelper (char c)
	QIODevicePrivate ()
virtual	~QIODevicePrivate ()
Public Functions inherited from QObjectPrivate
void	_q_reregisterTimers (void *pointer)
void	addConnection (int signal, Connection *c)
void	cleanConnectionLists ()
void	connectNotify (const char *signal)
void	deleteChildren ()
void	disconnectNotify (const char *signal)
bool	isSender (const QObject *receiver, const char *signal) const
bool	isSignalConnected (uint signalIdx) const
	Returns true if the signal with index signal_index from object sender is connected. More...
void	moveToThread_helper ()
	QObjectPrivate (int version=QObjectPrivateVersion)
QObjectList	receiverList (const char *signal) const
QObjectList	senderList () const
void	setParent_helper (QObject *)
void	setThreadData_helper (QThreadData *currentData, QThreadData *targetData)
int	signalIndex (const char *signalName) const
	Returns the signal index used in the internal connectionLists vector. More...
virtual	~QObjectPrivate ()
Public Functions inherited from QObjectData
virtual	~QObjectData ()=0
Public Functions inherited from QAbstractSocketEngineReceiver
virtual	~QAbstractSocketEngineReceiver ()

Static Public Functions
static QAbstractSocketEngine *	getSocketEngine (QAbstractSocket *)
static void	pauseSocketNotifiers (QAbstractSocket *)
static void	resumeSocketNotifiers (QAbstractSocket *)
Static Public Functions inherited from QObjectPrivate
static void	clearGuards (QObject *)
static QObjectPrivate *	get (QObject *o)
static void	resetCurrentSender (QObject *receiver, Sender *currentSender, Sender *previousSender)
static Sender *	setCurrentSender (QObject *receiver, Sender *sender)
static void	signalSignature (const QMetaMethod &signal, QVarLengthArray< char > *result)

Public Variables
bool	abortCalled
QList< QHostAddress >	addresses
int	blockingTimeout
int	cachedSocketDescriptor
bool	closeCalled
int	connectTimeElapsed
QTimer *	connectTimer
QTimer *	disconnectTimer
bool	emittedBytesWritten
bool	emittedReadyRead
QHostAddress	host
int	hostLookupId
QString	hostName
bool	isBuffered
QHostAddress	localAddress
quint16	localPort
QHostAddress	peerAddress
QString	peerName
quint16	peerPort
bool	pendingClose
quint16	port
bool	prePauseExceptionSocketNotifierState
bool	prePauseReadSocketNotifierState
bool	prePauseWriteSocketNotifierState
QNetworkProxy	proxy
QNetworkProxy	proxyInUse
QRingBuffer	readBuffer
qint64	readBufferMaxSize
bool	readSocketNotifierCalled
bool	readSocketNotifierState
bool	readSocketNotifierStateSet
QAbstractSocketEngine *	socketEngine
QAbstractSocket::SocketError	socketError
QAbstractSocket::SocketType	socketType
QAbstractSocket::SocketState	state
QRingBuffer	writeBuffer
Public Variables inherited from QIODevicePrivate
AccessMode	accessMode
bool	baseReadLineDataCalled
QIODevicePrivateLinearBuffer	buffer
qint64	devicePos
QString	errorString
bool	firstRead
QIODevice::OpenMode	openMode
qint64 *	pDevicePos
qint64	pos
qint64 *	pPos
qint64	seqDumpPos
Public Variables inherited from QObjectPrivate
union {
QObject *   currentChildBeingDeleted
QAbstractDeclarativeData *   declarativeData
};
quint32	connectedSignals [2]
QObjectConnectionListVector *	connectionLists
Sender *	currentSender
QList< QPointer< QObject > >	eventFilters
ExtraData *	extraData
QString	objectName
Connection *	senders
QAtomicPointer< QtSharedPointer::ExternalRefCountData >	sharedRefcount
QThreadData *	threadData
void *	unused
Public Variables inherited from QObjectData
uint	blockSig: 1
QObjectList	children
uint	hasGuards: 1
uint	inEventHandler: 1
uint	inThreadChangeEvent: 1
uint	isWidget: 1
QMetaObject *	metaObject
uint	ownObjectName: 1
QObject *	parent
uint	pendTimer: 1
int	postedEvents
QObject *	q_ptr
uint	receiveChildEvents: 1
uint	sendChildEvents: 1
uint	unused: 22
uint	wasDeleted: 1

Additional Inherited Members
Public Types inherited from QIODevicePrivate
enum	AccessMode { Unset, Sequential, RandomAccess }
Public Types inherited from QObjectPrivate
typedef void(*	StaticMetaCallFunction) (QObject *, QMetaObject::Call, int, void **)

Detailed Description

Definition at line 69 of file qabstractsocket_p.h.

Constructors and Destructors

QAbstractSocketPrivate()

QAbstractSocketPrivate::QAbstractSocketPrivate

(

)

Constructs a QAbstractSocketPrivate.

Warning

This function is not part of the public interface.

Initializes all members.

Definition at line 500 of file qabstractsocket.cpp.

    : readSocketNotifierCalled(false),
      readSocketNotifierState(false),
      readSocketNotifierStateSet(false),
      emittedReadyRead(false),
      emittedBytesWritten(false),
      abortCalled(false),
      closeCalled(false),
      pendingClose(false),
      port(0),
      localPort(0),
      peerPort(0),
      socketEngine(0),
      cachedSocketDescriptor(-1),
      readBufferMaxSize(0),
      readBuffer(QABSTRACTSOCKET_BUFFERSIZE),
      writeBuffer(QABSTRACTSOCKET_BUFFERSIZE),
      isBuffered(false),
      blockingTimeout(30000),
      connectTimer(0),
      disconnectTimer(0),
      connectTimeElapsed(0),
      hostLookupId(-1),
      socketType(QAbstractSocket::UnknownSocketType),
      state(QAbstractSocket::UnconnectedState),
      socketError(QAbstractSocket::UnknownSocketError)
{
}

~QAbstractSocketPrivate()

QAbstractSocketPrivate::~QAbstractSocketPrivate ( )

virtual

Destructs the QAbstractSocket.

Warning

This function is not part of the public interface.

If the socket layer is open, it will be reset.

Definition at line 537 of file qabstractsocket.cpp.

{
}

Functions

_q_abortConnectionAttempt()

void QAbstractSocketPrivate::_q_abortConnectionAttempt

(

)

This function is called after a certain number of seconds has passed while waiting for a connection.

Warning

This function is not part of the public interface.

It simply tests the connection, and continues to the next address if the connection failed.

Definition at line 1171 of file qabstractsocket.cpp.

Referenced by _q_connectToNextAddress(), and proxyAuthenticationRequired().

{
    Q_Q(QAbstractSocket);
#if defined(QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::_q_abortConnectionAttempt() (timed out)");
#endif
    if (socketEngine)
        socketEngine->setWriteNotificationEnabled(false);

    connectTimer->stop();

    if (addresses.isEmpty()) {
        state = QAbstractSocket::UnconnectedState;
        socketError = QAbstractSocket::SocketTimeoutError;
        q->setErrorString(QAbstractSocket::tr("Connection timed out"));
        emit q->stateChanged(state);
        emit q->error(socketError);
    } else {
        _q_connectToNextAddress();
    }
}

_q_connectToNextAddress()

void QAbstractSocketPrivate::_q_connectToNextAddress

(

)

Called by a queued or direct connection from _q_startConnecting() or _q_testConnection(), this function takes the first address of the pending addresses list and tries to connect to it.

Warning

This function is not part of the public interface.

If the connection succeeds, QAbstractSocket will emit connected(). Otherwise, error(ConnectionRefusedError) or error(SocketTimeoutError) is emitted.

Definition at line 1018 of file qabstractsocket.cpp.

Referenced by _q_abortConnectionAttempt(), _q_startConnecting(), _q_testConnection(), and proxyAuthenticationRequired().

{
    Q_Q(QAbstractSocket);
    do {
        // Check for more pending addresses
        if (addresses.isEmpty()) {
#if defined(QABSTRACTSOCKET_DEBUG)
            qDebug("QAbstractSocketPrivate::_q_connectToNextAddress(), all addresses failed.");
#endif
            state = QAbstractSocket::UnconnectedState;
            if (socketEngine) {
                if ((socketEngine->error() == QAbstractSocket::UnknownSocketError
#ifdef Q_OS_AIX
                     // On AIX, the second connect call will result in EINVAL and not
                     // ECONNECTIONREFUSED; although the meaning is the same.
                     || socketEngine->error() == QAbstractSocket::UnsupportedSocketOperationError
#endif
                    ) && socketEngine->state() == QAbstractSocket::ConnectingState) {
                    socketError = QAbstractSocket::ConnectionRefusedError;
                    q->setErrorString(QAbstractSocket::tr("Connection refused"));
                } else {
                    socketError = socketEngine->error();
                    q->setErrorString(socketEngine->errorString());
                }
            } else {
//                socketError = QAbstractSocket::ConnectionRefusedError;
//                q->setErrorString(QAbstractSocket::tr("Connection refused"));
            }
            emit q->stateChanged(state);
            emit q->error(socketError);
            return;
        }

        // Pick the first host address candidate
        host = addresses.takeFirst();
#if defined(QABSTRACTSOCKET_DEBUG)
        qDebug("QAbstractSocketPrivate::_q_connectToNextAddress(), connecting to %s:%i, %d left to try",
               host.toString().toLatin1().constData(), port, addresses.count());
#endif

#if defined(QT_NO_IPV6)
        if (host.protocol() == QAbstractSocket::IPv6Protocol) {
            // If we have no IPv6 support, then we will not be able to
            // connect. So we just pretend we didn't see this address.
#if defined(QABSTRACTSOCKET_DEBUG)
            qDebug("QAbstractSocketPrivate::_q_connectToNextAddress(), skipping IPv6 entry");
#endif
            continue;
        }
#endif

        if (!initSocketLayer(host.protocol())) {
            // hope that the next address is better
#if defined(QABSTRACTSOCKET_DEBUG)
            qDebug("QAbstractSocketPrivate::_q_connectToNextAddress(), failed to initialize sock layer");
#endif
            continue;
        }

        // Tries to connect to the address. If it succeeds immediately
        // (localhost address on BSD or any UDP connect), emit
        // connected() and return.
        if (socketEngine->connectToHost(host, port)) {
            //_q_testConnection();
            fetchConnectionParameters();
            return;
        }

        // cache the socket descriptor even if we're not fully connected yet
        cachedSocketDescriptor = socketEngine->socketDescriptor();

        // Check that we're in delayed connection state. If not, try
        // the next address
        if (socketEngine->state() != QAbstractSocket::ConnectingState) {
#if defined(QABSTRACTSOCKET_DEBUG)
            qDebug("QAbstractSocketPrivate::_q_connectToNextAddress(), connection failed (%s)",
                   socketEngine->errorString().toLatin1().constData());
#endif
            continue;
        }

        // Start the connect timer.
        if (threadData->eventDispatcher) {
            if (!connectTimer) {
                connectTimer = new QTimer(q);
                QObject::connect(connectTimer, SIGNAL(timeout()),
                                 q, SLOT(_q_abortConnectionAttempt()),
                                 Qt::DirectConnection);
            }
            connectTimer->start(QT_CONNECT_TIMEOUT);
        }

        // Wait for a write notification that will eventually call
        // _q_testConnection().
        socketEngine->setWriteNotificationEnabled(true);
        break;
    } while (state != QAbstractSocket::ConnectedState);
}

_q_forceDisconnect()

void QAbstractSocketPrivate::_q_forceDisconnect

(

)

Definition at line 1193 of file qabstractsocket.cpp.

Referenced by proxyAuthenticationRequired().

{
    Q_Q(QAbstractSocket);
    if (socketEngine && socketEngine->isValid() && state == QAbstractSocket::ClosingState) {
        socketEngine->close();
        q->disconnectFromHost();
    }
}

_q_startConnecting()

void QAbstractSocketPrivate::_q_startConnecting

(

const QHostInfo &

hostInfo

)

Slot connected to QHostInfo::lookupHost() in connectToHost().

Warning

This function is not part of the public interface.

This function starts the process of connecting to any number of candidate IP addresses for the host, if it was found. Calls _q_connectToNextAddress().

Definition at line 951 of file qabstractsocket.cpp.

Referenced by proxyAuthenticationRequired().

{
    Q_Q(QAbstractSocket);
    if (state != QAbstractSocket::HostLookupState)
        return;

    if (hostLookupId != -1 && hostLookupId != hostInfo.lookupId()) {
        qWarning("QAbstractSocketPrivate::_q_startConnecting() received hostInfo for wrong lookup ID %d expected %d", hostInfo.lookupId(), hostLookupId);
    }

    addresses = hostInfo.addresses();

#if defined(QABSTRACTSOCKET_DEBUG)
    QString s = QLatin1String("{");
    for (int i = 0; i < addresses.count(); ++i) {
        if (i != 0) s += QLatin1String(", ");
        s += addresses.at(i).toString();
    }
    s += QLatin1Char('}');
    qDebug("QAbstractSocketPrivate::_q_startConnecting(hostInfo == %s)", s.toLatin1().constData());
#endif

    // Try all addresses twice.
    addresses += addresses;

    // If there are no addresses in the host list, report this to the
    // user.
    if (addresses.isEmpty()) {
#if defined(QABSTRACTSOCKET_DEBUG)
        qDebug("QAbstractSocketPrivate::_q_startConnecting(), host not found");
#endif
        state = QAbstractSocket::UnconnectedState;
        socketError = QAbstractSocket::HostNotFoundError;
        q->setErrorString(QAbstractSocket::tr("Host not found"));
        emit q->stateChanged(state);
        emit q->error(QAbstractSocket::HostNotFoundError);
        return;
    }

    // Enter Connecting state (see also sn_write, which is called by
    // the write socket notifier after connect())
    state = QAbstractSocket::ConnectingState;
    emit q->stateChanged(state);

    // Report the successful host lookup
    emit q->hostFound();

    // Reset the total time spent connecting.
    connectTimeElapsed = 0;

    // The addresses returned by the lookup will be tested one after
    // another by _q_connectToNextAddress().
    _q_connectToNextAddress();
}

_q_testConnection()

void QAbstractSocketPrivate::_q_testConnection

(

)

Tests if a connection has been established.

Warning

This function is not part of the public interface.

If it has, connected() is emitted. Otherwise, _q_connectToNextAddress() is invoked.

Definition at line 1125 of file qabstractsocket.cpp.

Referenced by connectionNotification(), and proxyAuthenticationRequired().

{
    if (socketEngine) {
        if (threadData->eventDispatcher) {
            if (connectTimer)
                connectTimer->stop();
        }

        if (socketEngine->state() == QAbstractSocket::ConnectedState) {
            // Fetch the parameters if our connection is completed;
            // otherwise, fall out and try the next address.
            fetchConnectionParameters();
            if (pendingClose) {
                q_func()->disconnectFromHost();
                pendingClose = false;
            }
            return;
        }

        // don't retry the other addresses if we had a proxy error
        if (isProxyError(socketEngine->error()))
            addresses.clear();
    }

    if (threadData->eventDispatcher) {
        if (connectTimer)
            connectTimer->stop();
    }

#if defined(QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::_q_testConnection() connection failed,"
           " checking for alternative addresses");
#endif
    _q_connectToNextAddress();
}

canReadNotification()

bool QAbstractSocketPrivate::canReadNotification

(

)

Slot connected to the read socket notifier.

Warning

This function is not part of the public interface.

This slot is called when new data is available for reading, or when the socket has been closed. Handles recursive calls.

Definition at line 641 of file qabstractsocket.cpp.

Referenced by proxyAuthenticationRequired(), and readNotification().

{
    Q_Q(QAbstractSocket);
#if defined (QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::canReadNotification()");
#endif

    // Prevent recursive calls
    if (readSocketNotifierCalled) {
        if (!readSocketNotifierStateSet) {
            readSocketNotifierStateSet = true;
            readSocketNotifierState = socketEngine->isReadNotificationEnabled();
            socketEngine->setReadNotificationEnabled(false);
        }
    }
    QScopedValueRollback<bool> rsncrollback(readSocketNotifierCalled);
    readSocketNotifierCalled = true;

    if (!isBuffered)
        socketEngine->setReadNotificationEnabled(false);

    // If buffered, read data from the socket into the read buffer
    qint64 newBytes = 0;
    if (isBuffered) {
        // Return if there is no space in the buffer
        if (readBufferMaxSize && readBuffer.size() >= readBufferMaxSize) {
#if defined (QABSTRACTSOCKET_DEBUG)
            qDebug("QAbstractSocketPrivate::canReadNotification() buffer is full");
#endif
            return false;
        }

        // If reading from the socket fails after getting a read
        // notification, close the socket.
        newBytes = readBuffer.size();
        if (!readFromSocket()) {
#if defined (QABSTRACTSOCKET_DEBUG)
            qDebug("QAbstractSocketPrivate::canReadNotification() disconnecting socket");
#endif
            q->disconnectFromHost();
            return false;
        }
        newBytes = readBuffer.size() - newBytes;

        // If read buffer is full, disable the read socket notifier.
        if (readBufferMaxSize && readBuffer.size() == readBufferMaxSize) {
            socketEngine->setReadNotificationEnabled(false);
        }
    }

    // only emit readyRead() when not recursing, and only if there is data available
    bool hasData = newBytes > 0
#ifndef QT_NO_UDPSOCKET
        || (!isBuffered && socketType != QAbstractSocket::TcpSocket && socketEngine && socketEngine->hasPendingDatagrams())
#endif
        || (!isBuffered && socketType == QAbstractSocket::TcpSocket && socketEngine)
        ;

    if (!emittedReadyRead && hasData) {
        QScopedValueRollback<bool> r(emittedReadyRead);
        emittedReadyRead = true;
        emit q->readyRead();
    }

    // If we were closed as a result of the readyRead() signal,
    // return.
    if (state == QAbstractSocket::UnconnectedState || state == QAbstractSocket::ClosingState) {
#if defined (QABSTRACTSOCKET_DEBUG)
        qDebug("QAbstractSocketPrivate::canReadNotification() socket is closing - returning");
#endif
        return true;
    }

    if (!hasData && socketEngine)
        socketEngine->setReadNotificationEnabled(true);

    // reset the read socket notifier state if we reentered inside the
    // readyRead() connected slot.
    if (readSocketNotifierStateSet && socketEngine &&
        readSocketNotifierState != socketEngine->isReadNotificationEnabled()) {
        socketEngine->setReadNotificationEnabled(readSocketNotifierState);
        readSocketNotifierStateSet = false;
    }
    return true;
}

canWriteNotification()

bool QAbstractSocketPrivate::canWriteNotification

(

)

Slot connected to the write socket notifier.

Warning

This function is not part of the public interface.

It's called during a delayed connect or when the socket is ready for writing.

Definition at line 735 of file qabstractsocket.cpp.

Referenced by proxyAuthenticationRequired(), and writeNotification().

{
#if defined (Q_OS_WIN)
    if (socketEngine && socketEngine->isWriteNotificationEnabled())
        socketEngine->setWriteNotificationEnabled(false);
#endif

#if defined (QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::canWriteNotification() flushing");
#endif
    int tmp = writeBuffer.size();
    flush();

    if (socketEngine) {
#if defined (Q_OS_WIN)
        if (!writeBuffer.isEmpty())
            socketEngine->setWriteNotificationEnabled(true);
#else
        if (writeBuffer.isEmpty() && socketEngine->bytesToWrite() == 0)
            socketEngine->setWriteNotificationEnabled(false);
#endif
    }

    return (writeBuffer.size() < tmp);
}

connectionNotification()

void QAbstractSocketPrivate::connectionNotification ( )

virtual

Slot connected to a notification of connection status change.

Warning

This function is not part of the public interface.

Either we finished connecting or we failed to connect.

Implements QAbstractSocketEngineReceiver.

Definition at line 769 of file qabstractsocket.cpp.

Referenced by exceptionNotification().

{
    // If in connecting state, check if the connection has been
    // established, otherwise flush pending data.
    if (state == QAbstractSocket::ConnectingState) {
#if defined (QABSTRACTSOCKET_DEBUG)
        qDebug("QAbstractSocketPrivate::connectionNotification() testing connection");
#endif
        _q_testConnection();
    }
}

exceptionNotification()

void QAbstractSocketPrivate::exceptionNotification ( )

inlinevirtual

Implements QAbstractSocketEngineReceiver.

Definition at line 79 of file qabstractsocket_p.h.

{}

fetchConnectionParameters()

void QAbstractSocketPrivate::fetchConnectionParameters

(

)

Sets up the internal state after the connection has succeeded.

Warning

This function is not part of the public interface.

Definition at line 1269 of file qabstractsocket.cpp.

Referenced by _q_connectToNextAddress(), _q_testConnection(), and resolveProxy().

{
    Q_Q(QAbstractSocket);

    peerName = hostName;
    if (socketEngine) {
        socketEngine->setReadNotificationEnabled(true);
        socketEngine->setWriteNotificationEnabled(true);
        localPort = socketEngine->localPort();
        peerPort = socketEngine->peerPort();
        localAddress = socketEngine->localAddress();
        peerAddress = socketEngine->peerAddress();
        cachedSocketDescriptor = socketEngine->socketDescriptor();
    }

    state = QAbstractSocket::ConnectedState;
    emit q->stateChanged(state);
    emit q->connected();

#if defined(QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::fetchConnectionParameters() connection to %s:%i established",
           host.toString().toLatin1().constData(), port);
#endif
}

flush()

bool QAbstractSocketPrivate::flush

(

)

Writes pending data in the write buffers to the socket.

Warning

This function is not part of the public interface.

The function writes as much as it can without blocking.

It is usually invoked by canWriteNotification after one or more calls to write().

Emits bytesWritten().

Definition at line 794 of file qabstractsocket.cpp.

Referenced by canWriteNotification(), and resolveProxy().

{
    Q_Q(QAbstractSocket);
    if (!socketEngine || !socketEngine->isValid() || (writeBuffer.isEmpty()
        && socketEngine->bytesToWrite() == 0)) {
#if defined (QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::flush() nothing to do: valid ? %s, writeBuffer.isEmpty() ? %s",
           socketEngine->isValid() ? "yes" : "no", writeBuffer.isEmpty() ? "yes" : "no");
#endif

        // this covers the case when the buffer was empty, but we had to wait for the socket engine to finish
        if (state == QAbstractSocket::ClosingState)
            q->disconnectFromHost();

        return false;
    }

    int nextSize = writeBuffer.nextDataBlockSize();
    const char *ptr = writeBuffer.readPointer();

    // Attempt to write it all in one chunk.
    qint64 written = socketEngine->write(ptr, nextSize);
    if (written < 0) {
        socketError = socketEngine->error();
        q->setErrorString(socketEngine->errorString());
#if defined (QABSTRACTSOCKET_DEBUG)
        qDebug() << "QAbstractSocketPrivate::flush() write error, aborting." << socketEngine->errorString();
#endif
        emit q->error(socketError);
        // an unexpected error so close the socket.
        q->abort();
        return false;
    }

#if defined (QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::flush() %lld bytes written to the network",
           written);
#endif

    // Remove what we wrote so far.
    writeBuffer.free(written);
    if (written > 0) {
        // Don't emit bytesWritten() recursively.
        if (!emittedBytesWritten) {
            QScopedValueRollback<bool> r(emittedBytesWritten);
            emittedBytesWritten = true;
            emit q->bytesWritten(written);
        }
    }

    if (writeBuffer.isEmpty() && socketEngine && socketEngine->isWriteNotificationEnabled()
        && !socketEngine->bytesToWrite())
        socketEngine->setWriteNotificationEnabled(false);
    if (state == QAbstractSocket::ClosingState)
        q->disconnectFromHost();

    return true;
}

getSocketEngine()

QAbstractSocketEngine * QAbstractSocketPrivate::getSocketEngine ( QAbstractSocket *  socket )

static

Definition at line 1318 of file qabstractsocket.cpp.

{
    return socket->d_func()->socketEngine;
}

initSocketLayer()

bool QAbstractSocketPrivate::initSocketLayer

(

QAbstractSocket::NetworkLayerProtocol

protocol

)

Initializes the socket layer to by of type type, using the network layer protocol protocol.

Warning

This function is not part of the public interface.

Resets the socket layer first if it's already initialized. Sets up the socket notifiers.

Definition at line 577 of file qabstractsocket.cpp.

Referenced by _q_connectToNextAddress(), QUdpSocketPrivate::doEnsureInitialized(), resolveProxy(), and startConnectingByName().

{
#ifdef QT_NO_NETWORKPROXY
    // this is here to avoid a duplication of the call to createSocketEngine below
    static const QNetworkProxy &proxyInUse = *(QNetworkProxy *)0;
#endif

    Q_Q(QAbstractSocket);
#if defined (QABSTRACTSOCKET_DEBUG)
    QString typeStr;
    if (q->socketType() == QAbstractSocket::TcpSocket) typeStr = QLatin1String("TcpSocket");
    else if (q->socketType() == QAbstractSocket::UdpSocket) typeStr = QLatin1String("UdpSocket");
    else typeStr = QLatin1String("UnknownSocketType");
    QString protocolStr;
    if (protocol == QAbstractSocket::IPv4Protocol) protocolStr = QLatin1String("IPv4Protocol");
    else if (protocol == QAbstractSocket::IPv6Protocol) protocolStr = QLatin1String("IPv6Protocol");
    else protocolStr = QLatin1String("UnknownNetworkLayerProtocol");
#endif

    resetSocketLayer();
    socketEngine = QAbstractSocketEngine::createSocketEngine(q->socketType(), proxyInUse, q);
    if (!socketEngine) {
        socketError = QAbstractSocket::UnsupportedSocketOperationError;
        q->setErrorString(QAbstractSocket::tr("Operation on socket is not supported"));
        return false;
    }
#ifndef QT_NO_BEARERMANAGEMENT
    //copy network session down to the socket engine (if it has been set)
    socketEngine->setProperty("_q_networksession", q->property("_q_networksession"));
#endif
#ifndef QT_NO_NETWORKPROXY
    //copy user agent to socket engine (if it has been set)
    socketEngine->setProperty("_q_user-agent", q->property("_q_user-agent"));
#endif
    if (!socketEngine->initialize(q->socketType(), protocol)) {
#if defined (QABSTRACTSOCKET_DEBUG)
        qDebug("QAbstractSocketPrivate::initSocketLayer(%s, %s) failed (%s)",
               typeStr.toLatin1().constData(), protocolStr.toLatin1().constData(),
               socketEngine->errorString().toLatin1().constData());
#endif
        socketError = socketEngine->error();
    q->setErrorString(socketEngine->errorString());
        return false;
    }

    if (threadData->eventDispatcher)
        socketEngine->setReceiver(this);

#if defined (QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::initSocketLayer(%s, %s) success",
           typeStr.toLatin1().constData(), protocolStr.toLatin1().constData());
#endif
    return true;
}

pauseSocketNotifiers()

void QAbstractSocketPrivate::pauseSocketNotifiers ( QAbstractSocket *  socket )

static

Definition at line 1295 of file qabstractsocket.cpp.

Referenced by QHttpNetworkConnectionPrivate::pauseConnection(), and QSslSocketPrivate::pauseSocketNotifiers().

{
    QAbstractSocketEngine *socketEngine = socket->d_func()->socketEngine;
    if (!socketEngine)
        return;
    socket->d_func()->prePauseReadSocketNotifierState = socketEngine->isReadNotificationEnabled();
    socket->d_func()->prePauseWriteSocketNotifierState = socketEngine->isWriteNotificationEnabled();
    socket->d_func()->prePauseExceptionSocketNotifierState = socketEngine->isExceptionNotificationEnabled();
    socketEngine->setReadNotificationEnabled(false);
    socketEngine->setWriteNotificationEnabled(false);
    socketEngine->setExceptionNotificationEnabled(false);
}

proxyAuthenticationRequired()

void QAbstractSocketPrivate::proxyAuthenticationRequired ( const QNetworkProxy &  proxy, QAuthenticator *  authenticator  )

inlinevirtual

Implements QAbstractSocketEngineReceiver.

Definition at line 82 of file qabstractsocket_p.h.

Referenced by QSslSocketPrivate::createPlainSocket().

                                                                                                       {
        Q_Q(QAbstractSocket);
        q->proxyAuthenticationRequired(proxy, authenticator);
    }

readFromSocket()

bool QAbstractSocketPrivate::readFromSocket

(

)

Reads data from the socket layer into the read buffer.

Warning

This function is not part of the public interface.

Returns true on success; otherwise false.

Definition at line 1210 of file qabstractsocket.cpp.

Referenced by canReadNotification(), and resolveProxy().

{
    Q_Q(QAbstractSocket);
    // Find how many bytes we can read from the socket layer.
    qint64 bytesToRead = socketEngine->bytesAvailable();
    if (bytesToRead == 0) {
        // Under heavy load, certain conditions can trigger read notifications
        // for socket notifiers on which there is no activity. If we continue
        // to read 0 bytes from the socket, we will trigger behavior similar
        // to that which signals a remote close. When we hit this condition,
        // we try to read 4k of data from the socket, which will give us either
        // an EAGAIN/EWOULDBLOCK if the connection is alive (i.e., the remote
        // host has _not_ disappeared).
        bytesToRead = 4096;
    }
    if (readBufferMaxSize && bytesToRead > (readBufferMaxSize - readBuffer.size()))
        bytesToRead = readBufferMaxSize - readBuffer.size();

#if defined(QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::readFromSocket() about to read %d bytes",
           int(bytesToRead));
#endif

    // Read from the socket, store data in the read buffer.
    char *ptr = readBuffer.reserve(bytesToRead);
    qint64 readBytes = socketEngine->read(ptr, bytesToRead);
    if (readBytes == -2) {
        // No bytes currently available for reading.
        readBuffer.chop(bytesToRead);
        return true;
    }
    readBuffer.chop(int(bytesToRead - (readBytes < 0 ? qint64(0) : readBytes)));
#if defined(QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::readFromSocket() got %d bytes, buffer size = %d",
           int(readBytes), readBuffer.size());
#endif

    if (!socketEngine->isValid()) {
        socketError = socketEngine->error();
        q->setErrorString(socketEngine->errorString());
        emit q->error(socketError);
#if defined(QABSTRACTSOCKET_DEBUG)
        qDebug("QAbstractSocketPrivate::readFromSocket() read failed: %s",
               q->errorString().toLatin1().constData());
#endif
        resetSocketLayer();
        return false;
    }

    return true;
}

readNotification()

void QAbstractSocketPrivate::readNotification ( )

inlinevirtual

Implements QAbstractSocketEngineReceiver.

Definition at line 77 of file qabstractsocket_p.h.

{ canReadNotification(); }

resetSocketLayer()

void QAbstractSocketPrivate::resetSocketLayer

(

)

Resets the socket layer, clears the read and write buffers and deletes any socket notifiers.

Warning

This function is not part of the public interface.

Definition at line 549 of file qabstractsocket.cpp.

Referenced by initSocketLayer(), readFromSocket(), and resolveProxy().

{
#if defined (QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::resetSocketLayer()");
#endif

    if (socketEngine) {
        socketEngine->close();
        socketEngine->disconnect();
        delete socketEngine;
        socketEngine = 0;
        cachedSocketDescriptor = -1;
    }
    if (connectTimer)
        connectTimer->stop();
    if (disconnectTimer)
        disconnectTimer->stop();
}

resolveProxy() [1/2]

void QAbstractSocketPrivate::resolveProxy	(	const QString &	hostname,
		quint16	port
	)

Resolve the proxy to its final value.

Warning

This function is not part of the public interface.

Definition at line 861 of file qabstractsocket.cpp.

Referenced by QUdpSocketPrivate::doEnsureInitialized().

{
    QList<QNetworkProxy> proxies;

    if (proxy.type() != QNetworkProxy::DefaultProxy) {
        // a non-default proxy was set with setProxy
        proxies << proxy;
    } else {
        // try the application settings instead
        QNetworkProxyQuery query(hostname, port, QString(),
                                 socketType == QAbstractSocket::TcpSocket ?
                                 QNetworkProxyQuery::TcpSocket :
                                 QNetworkProxyQuery::UdpSocket);
        proxies = QNetworkProxyFactory::proxyForQuery(query);
    }

    // return the first that we can use
    foreach (const QNetworkProxy &p, proxies) {
        if (socketType == QAbstractSocket::UdpSocket &&
            (p.capabilities() & QNetworkProxy::UdpTunnelingCapability) == 0)
            continue;

        if (socketType == QAbstractSocket::TcpSocket &&
            (p.capabilities() & QNetworkProxy::TunnelingCapability) == 0)
            continue;

        proxyInUse = p;
        return;
    }

    // no proxy found
    // DefaultProxy here will raise an error
    proxyInUse = QNetworkProxy();
}

resolveProxy() [2/2]

void QAbstractSocketPrivate::resolveProxy ( quint16  port )

inline

Definition at line 130 of file qabstractsocket_p.h.

Referenced by resolveProxy().

{ resolveProxy(QString(), port); }

resumeSocketNotifiers()

void QAbstractSocketPrivate::resumeSocketNotifiers ( QAbstractSocket *  socket )

static

Definition at line 1308 of file qabstractsocket.cpp.

Referenced by QHttpNetworkConnectionPrivate::resumeConnection(), and QSslSocketPrivate::resumeSocketNotifiers().

{
    QAbstractSocketEngine *socketEngine = socket->d_func()->socketEngine;
    if (!socketEngine)
        return;
    socketEngine->setReadNotificationEnabled(socket->d_func()->prePauseReadSocketNotifierState);
    socketEngine->setWriteNotificationEnabled(socket->d_func()->prePauseWriteSocketNotifierState);
    socketEngine->setExceptionNotificationEnabled(socket->d_func()->prePauseExceptionSocketNotifierState);
}

setupSocketNotifiers()

void QAbstractSocketPrivate::setupSocketNotifiers

(

)

Referenced by resolveProxy().

startConnectingByName()

void QAbstractSocketPrivate::startConnectingByName

(

const QString &

host

)

Starts the connection to host, like _q_startConnecting below, but without hostname resolution.

Warning

This function is not part of the public interface.

Definition at line 905 of file qabstractsocket.cpp.

Referenced by resolveProxy().

{
    Q_Q(QAbstractSocket);
    if (state == QAbstractSocket::ConnectingState || state == QAbstractSocket::ConnectedState)
        return;

#if defined(QABSTRACTSOCKET_DEBUG)
    qDebug("QAbstractSocketPrivate::startConnectingByName(host == %s)", qPrintable(host));
#endif

    // ### Let the socket engine drive this?
    state = QAbstractSocket::ConnectingState;
    emit q->stateChanged(state);

    connectTimeElapsed = 0;

    if (initSocketLayer(QAbstractSocket::UnknownNetworkLayerProtocol)) {
        if (socketEngine->connectToHostByName(host, port) ||
            socketEngine->state() == QAbstractSocket::ConnectingState) {
            cachedSocketDescriptor = socketEngine->socketDescriptor();

            return;
        }

        // failed to connect
        socketError = socketEngine->error();
        q->setErrorString(socketEngine->errorString());
    }

    state = QAbstractSocket::UnconnectedState;
    emit q->error(socketError);
    emit q->stateChanged(state);
}

writeNotification()

void QAbstractSocketPrivate::writeNotification ( )

inlinevirtual

Implements QAbstractSocketEngineReceiver.

Definition at line 78 of file qabstractsocket_p.h.

{ canWriteNotification(); }

Properties

abortCalled

bool QAbstractSocketPrivate::abortCalled

Definition at line 105 of file qabstractsocket_p.h.

addresses

QList<QHostAddress> QAbstractSocketPrivate::addresses

Definition at line 112 of file qabstractsocket_p.h.

Referenced by _q_abortConnectionAttempt(), _q_connectToNextAddress(), _q_startConnecting(), and _q_testConnection().

blockingTimeout

int QAbstractSocketPrivate::blockingTimeout

Definition at line 146 of file qabstractsocket_p.h.

cachedSocketDescriptor

int QAbstractSocketPrivate::cachedSocketDescriptor

Definition at line 121 of file qabstractsocket_p.h.

Referenced by QSslSocketPrivate::_q_connectedSlot(), _q_connectToNextAddress(), fetchConnectionParameters(), resetSocketLayer(), and startConnectingByName().

closeCalled

bool QAbstractSocketPrivate::closeCalled

Definition at line 106 of file qabstractsocket_p.h.

connectTimeElapsed

int QAbstractSocketPrivate::connectTimeElapsed

Definition at line 150 of file qabstractsocket_p.h.

Referenced by _q_startConnecting(), and startConnectingByName().

connectTimer

QTimer* QAbstractSocketPrivate::connectTimer

Definition at line 148 of file qabstractsocket_p.h.

Referenced by _q_abortConnectionAttempt(), _q_connectToNextAddress(), _q_testConnection(), and resetSocketLayer().

disconnectTimer

QTimer* QAbstractSocketPrivate::disconnectTimer

Definition at line 149 of file qabstractsocket_p.h.

Referenced by resetSocketLayer().

emittedBytesWritten

bool QAbstractSocketPrivate::emittedBytesWritten

Definition at line 103 of file qabstractsocket_p.h.

Referenced by flush(), and QSslSocketBackendPrivate::transmit().

emittedReadyRead

bool QAbstractSocketPrivate::emittedReadyRead

Definition at line 102 of file qabstractsocket_p.h.

Referenced by canReadNotification().

host

QHostAddress QAbstractSocketPrivate::host

Definition at line 111 of file qabstractsocket_p.h.

Referenced by _q_connectToNextAddress(), and fetchConnectionParameters().

hostLookupId

int QAbstractSocketPrivate::hostLookupId

Definition at line 152 of file qabstractsocket_p.h.

Referenced by _q_startConnecting().

hostName

QString QAbstractSocketPrivate::hostName

Definition at line 109 of file qabstractsocket_p.h.

Referenced by QSslSocketPrivate::_q_connectedSlot(), fetchConnectionParameters(), and QSslSocketBackendPrivate::initSslContext().

isBuffered

bool QAbstractSocketPrivate::isBuffered

Definition at line 145 of file qabstractsocket_p.h.

Referenced by canReadNotification().

localAddress

QHostAddress QAbstractSocketPrivate::localAddress

Definition at line 116 of file qabstractsocket_p.h.

Referenced by fetchConnectionParameters().

localPort

quint16 QAbstractSocketPrivate::localPort

Definition at line 114 of file qabstractsocket_p.h.

Referenced by fetchConnectionParameters().

peerAddress

QHostAddress QAbstractSocketPrivate::peerAddress

Definition at line 117 of file qabstractsocket_p.h.

Referenced by fetchConnectionParameters().

peerName

QString QAbstractSocketPrivate::peerName

Definition at line 118 of file qabstractsocket_p.h.

Referenced by fetchConnectionParameters(), and QSslSocketBackendPrivate::startHandshake().

peerPort

quint16 QAbstractSocketPrivate::peerPort

Definition at line 115 of file qabstractsocket_p.h.

Referenced by fetchConnectionParameters().

pendingClose

bool QAbstractSocketPrivate::pendingClose

Definition at line 107 of file qabstractsocket_p.h.

Referenced by QSslSocketPrivate::_q_connectedSlot(), _q_testConnection(), and QSslSocketBackendPrivate::startHandshake().

port

quint16 QAbstractSocketPrivate::port

Definition at line 110 of file qabstractsocket_p.h.

Referenced by _q_connectToNextAddress(), fetchConnectionParameters(), and startConnectingByName().

prePauseExceptionSocketNotifierState

bool QAbstractSocketPrivate::prePauseExceptionSocketNotifierState

Definition at line 161 of file qabstractsocket_p.h.

prePauseReadSocketNotifierState

bool QAbstractSocketPrivate::prePauseReadSocketNotifierState

Definition at line 159 of file qabstractsocket_p.h.

prePauseWriteSocketNotifierState

bool QAbstractSocketPrivate::prePauseWriteSocketNotifierState

Definition at line 160 of file qabstractsocket_p.h.

proxy

QNetworkProxy QAbstractSocketPrivate::proxy

Definition at line 124 of file qabstractsocket_p.h.

Referenced by resolveProxy().

proxyInUse

QNetworkProxy QAbstractSocketPrivate::proxyInUse

Definition at line 125 of file qabstractsocket_p.h.

Referenced by initSocketLayer(), and resolveProxy().

readBuffer

QRingBuffer QAbstractSocketPrivate::readBuffer

Definition at line 142 of file qabstractsocket_p.h.

Referenced by canReadNotification(), QSslSocketPrivate::createPlainSocket(), QSslSocketPrivate::init(), readFromSocket(), and QSslSocketBackendPrivate::transmit().

readBufferMaxSize

qint64 QAbstractSocketPrivate::readBufferMaxSize

Definition at line 141 of file qabstractsocket_p.h.

Referenced by canReadNotification(), QSslSocketPrivate::createPlainSocket(), readFromSocket(), QSslSocketBackendPrivate::startHandshake(), and QSslSocketBackendPrivate::transmit().

readSocketNotifierCalled

bool QAbstractSocketPrivate::readSocketNotifierCalled

Definition at line 98 of file qabstractsocket_p.h.

Referenced by canReadNotification().

readSocketNotifierState

bool QAbstractSocketPrivate::readSocketNotifierState

Definition at line 99 of file qabstractsocket_p.h.

Referenced by canReadNotification().

readSocketNotifierStateSet

bool QAbstractSocketPrivate::readSocketNotifierStateSet

Definition at line 100 of file qabstractsocket_p.h.

Referenced by canReadNotification().

socketEngine

QAbstractSocketEngine* QAbstractSocketPrivate::socketEngine

Definition at line 120 of file qabstractsocket_p.h.

Referenced by _q_abortConnectionAttempt(), _q_connectToNextAddress(), _q_forceDisconnect(), _q_testConnection(), canReadNotification(), canWriteNotification(), QUdpSocketPrivate::doEnsureInitialized(), fetchConnectionParameters(), flush(), initSocketLayer(), pauseSocketNotifiers(), readFromSocket(), resetSocketLayer(), resumeSocketNotifiers(), and startConnectingByName().

socketError

QAbstractSocket::SocketError QAbstractSocketPrivate::socketError

Definition at line 157 of file qabstractsocket_p.h.

Referenced by _q_abortConnectionAttempt(), _q_connectToNextAddress(), _q_startConnecting(), QUdpSocketPrivate::doEnsureInitialized(), flush(), initSocketLayer(), readFromSocket(), and startConnectingByName().

socketType

QAbstractSocket::SocketType QAbstractSocketPrivate::socketType

Definition at line 154 of file qabstractsocket_p.h.

Referenced by canReadNotification(), and resolveProxy().

state

QAbstractSocket::SocketState QAbstractSocketPrivate::state

Definition at line 155 of file qabstractsocket_p.h.

Referenced by _q_abortConnectionAttempt(), QSslSocketPrivate::_q_bytesWrittenSlot(), _q_connectToNextAddress(), _q_forceDisconnect(), _q_startConnecting(), canReadNotification(), connectionNotification(), fetchConnectionParameters(), flush(), and startConnectingByName().

writeBuffer

QRingBuffer QAbstractSocketPrivate::writeBuffer

Definition at line 143 of file qabstractsocket_p.h.

Referenced by QSslSocketPrivate::_q_bytesWrittenSlot(), QSslSocketPrivate::_q_flushWriteBuffer(), canWriteNotification(), QSslSocketPrivate::createPlainSocket(), flush(), QSslSocketPrivate::init(), and QSslSocketBackendPrivate::transmit().

---

The documentation for this class was generated from the following files:

• /src/network/socket/qabstractsocket_p.h
• /src/network/socket/qabstractsocket.cpp