#include <qlocalsocket_p.h>

Inheritance diagram for QLocalSocketPrivate:

Public Functions
void	_q_canWrite ()

void	_q_emitReadyRead ()

void	_q_notified ()

void	_q_pipeClosed ()

DWORD	checkPipeState ()
	Returns the number of available bytes in the pipe. More...

void	checkReadyRead ()

bool	completeAsyncRead ()
	Sets the correct size of the read buffer after a read operation. More...

void	destroyPipeHandles ()

void	init ()

	QLocalSocketPrivate ()

void	setErrorString (const QString &function)

void	startAsyncRead ()

	~QLocalSocketPrivate ()

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 Variables
int	actualReadBufferSize

QWinEventNotifier *	dataReadNotifier

QLocalSocket::LocalSocketError	error

QString	fullServerName

HANDLE	handle

OVERLAPPED	overlapped

bool	pendingReadyRead

bool	pipeClosed

QWindowsPipeWriter *	pipeWriter

QRingBuffer	readBuffer

qint64	readBufferMaxSize

bool	readSequenceStarted

QString	serverName

QLocalSocket::LocalSocketState	state

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

Static Public Variables
static const qint64	initialReadBufferSize = 4096

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

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)

Detailed Description

Definition at line 114 of file qlocalsocket_p.h.

Constructors and Destructors

◆ QLocalSocketPrivate()

QLocalSocketPrivate::QLocalSocketPrivate ( )

Definition at line 52 of file qlocalsocket_tcp.cpp.

Referenced by setErrorString().

                                          : QIODevicePrivate(),
         tcpSocket(0),
         ownsTcpSocket(true),
         state(QLocalSocket::UnconnectedState)
 {
 }

◆ ~QLocalSocketPrivate()

QLocalSocketPrivate::~QLocalSocketPrivate ( )

Definition at line 117 of file qlocalsocket_win.cpp.

 {
     destroyPipeHandles();
     CloseHandle(overlapped.hEvent);
 }

Functions

◆ _q_canWrite()

void QLocalSocketPrivate::_q_canWrite ( )

Definition at line 506 of file qlocalsocket_win.cpp.

Referenced by completeAsyncRead().

 {
     Q_Q(QLocalSocket);
     if (state == QLocalSocket::ClosingState)
         q->close();
 }

◆ _q_emitReadyRead()

void QLocalSocketPrivate::_q_emitReadyRead ( )

Definition at line 528 of file qlocalsocket_win.cpp.

Referenced by checkReadyRead().

 {
     if (pendingReadyRead) {
         Q_Q(QLocalSocket);
         pendingReadyRead = false;
         emit q->readyRead();
     }
 }

◆ _q_notified()

void QLocalSocketPrivate::_q_notified ( )

Definition at line 513 of file qlocalsocket_win.cpp.

 {
     Q_Q(QLocalSocket);
     if (!completeAsyncRead()) {
         pipeClosed = true;
         emit q->readChannelFinished();
         if (actualReadBufferSize == 0)
             QTimer::singleShot(0, q, SLOT(_q_pipeClosed()));
         return;
     }
     startAsyncRead();
     pendingReadyRead = false;
     emit q->readyRead();
 }

◆ _q_pipeClosed()

void QLocalSocketPrivate::_q_pipeClosed ( )

Definition at line 392 of file qlocalsocket_win.cpp.

Referenced by _q_notified(), checkPipeState(), and destroyPipeHandles().

 {
     Q_Q(QLocalSocket);
     q->close();
 }

◆ checkPipeState()

DWORD QLocalSocketPrivate::checkPipeState ( )

Returns the number of available bytes in the pipe.

Warning: This function is not part of the public interface.

Sets QLocalSocketPrivate::pipeClosed to true if the connection is broken.

Definition at line 375 of file qlocalsocket_win.cpp.

Referenced by startAsyncRead().

 {
     Q_Q(QLocalSocket);
     DWORD bytes;
     if (PeekNamedPipe(handle, NULL, 0, NULL, &bytes, NULL)) {
         return bytes;
     } else {
         if (!pipeClosed) {
             pipeClosed = true;
             emit q->readChannelFinished();
             if (actualReadBufferSize == 0)
                 QTimer::singleShot(0, q, SLOT(_q_pipeClosed()));
         }
     }
     return 0;
 }

◆ checkReadyRead()

void QLocalSocketPrivate::checkReadyRead ( )

Warning: This function is not part of the public interface. Schedules or cancels a readyRead() emission depending on actual data availability

Definition at line 239 of file qlocalsocket_win.cpp.

 {
     if (actualReadBufferSize > 0) {
         if (!pendingReadyRead) {
             Q_Q(QLocalSocket);
             QTimer::singleShot(0, q, SLOT(_q_emitReadyRead()));
             pendingReadyRead = true;
         }
     } else {
         pendingReadyRead = false;
     }
 }

◆ completeAsyncRead()

bool QLocalSocketPrivate::completeAsyncRead ( )

Sets the correct size of the read buffer after a read operation.

Warning: This function is not part of the public interface.

Returns false, if an error occurred or the connection dropped.

Definition at line 319 of file qlocalsocket_win.cpp.

Referenced by _q_notified(), and startAsyncRead().

 {
     ResetEvent(overlapped.hEvent);
     readSequenceStarted = false;
 
     DWORD bytesRead;
     if (!GetOverlappedResult(handle, &overlapped, &bytesRead, TRUE)) {
         switch (GetLastError()) {
         case ERROR_MORE_DATA:
             // This is not an error. We're connected to a message mode
             // pipe and the message didn't fit into the pipe's system
             // buffer. We will read the remaining data in the next call.
             break;
         case ERROR_PIPE_NOT_CONNECTED:
             return false;
         default:
             setErrorString(QLatin1String("QLocalSocketPrivate::completeAsyncRead"));
             return false;
         }
     }
 
     actualReadBufferSize += bytesRead;
     readBuffer.truncate(actualReadBufferSize);
     return true;
 }

◆ destroyPipeHandles()

void QLocalSocketPrivate::destroyPipeHandles ( )

Definition at line 123 of file qlocalsocket_win.cpp.

Referenced by ~QLocalSocketPrivate().

 {
     if (handle != INVALID_HANDLE_VALUE) {
         DisconnectNamedPipe(handle);
         CloseHandle(handle);
     }
 }

◆ init()

void QLocalSocketPrivate::init ( )

Definition at line 59 of file qlocalsocket_tcp.cpp.

 {
     setSocket(new QLocalUnixSocket);
 }

◆ setErrorString()

void QLocalSocketPrivate::setErrorString ( const QString & function )

Definition at line 59 of file qlocalsocket_win.cpp.

Referenced by completeAsyncRead(), destroyPipeHandles(), and startAsyncRead().

 {
     Q_Q(QLocalSocket);
     BOOL windowsError = GetLastError();
     QLocalSocket::LocalSocketState currentState = state;
 
     // If the connectToServer fails due to WaitNamedPipe() time-out, assume ConnectionError  
     if (state == QLocalSocket::ConnectingState && windowsError == ERROR_SEM_TIMEOUT)
         windowsError = ERROR_NO_DATA;
 
     switch (windowsError) {
     case ERROR_PIPE_NOT_CONNECTED:
     case ERROR_BROKEN_PIPE:
     case ERROR_NO_DATA:
         error = QLocalSocket::ConnectionError;
         errorString = QLocalSocket::tr("%1: Connection error").arg(function);
         state = QLocalSocket::UnconnectedState;
         break;
     case ERROR_FILE_NOT_FOUND:
         error = QLocalSocket::ServerNotFoundError;
         errorString = QLocalSocket::tr("%1: Invalid name").arg(function);
         state = QLocalSocket::UnconnectedState;
         break;
     case ERROR_ACCESS_DENIED:
         error = QLocalSocket::SocketAccessError;
         errorString = QLocalSocket::tr("%1: Access denied").arg(function);
         state = QLocalSocket::UnconnectedState;
         break;
     default:
         error = QLocalSocket::UnknownSocketError;
         errorString = QLocalSocket::tr("%1: Unknown error %2").arg(function).arg(windowsError);
 #if defined QLOCALSOCKET_DEBUG
         qWarning() << "QLocalSocket error not handled:" << errorString;
 #endif
         state = QLocalSocket::UnconnectedState;
     }
 
     if (currentState != state) {
         q->emit stateChanged(state);
         if (state == QLocalSocket::UnconnectedState)
             q->emit disconnected();
     }
     emit q->error(error);
 }

◆ startAsyncRead()

void QLocalSocketPrivate::startAsyncRead ( )

Warning: This function is not part of the public interface. Reads data from the socket into the readbuffer

Definition at line 256 of file qlocalsocket_win.cpp.

Referenced by _q_notified().

 {
     do {
         DWORD bytesToRead = checkPipeState();
         if (pipeClosed)
             return;
 
         if (bytesToRead == 0) {
             // There are no bytes in the pipe but we need to
             // start the overlapped read with some buffer size.
             bytesToRead = initialReadBufferSize;
         }
 
         if (readBufferMaxSize && bytesToRead > (readBufferMaxSize - readBuffer.size())) {
             bytesToRead = readBufferMaxSize - readBuffer.size();
             if (bytesToRead == 0) {
                 // Buffer is full. User must read data from the buffer
                 // before we can read more from the pipe.
                 return;
             }
         }
 
         char *ptr = readBuffer.reserve(bytesToRead);
 
         readSequenceStarted = true;
         if (ReadFile(handle, ptr, bytesToRead, NULL, &overlapped)) {
             completeAsyncRead();
         } else {
             switch (GetLastError()) {
                 case ERROR_IO_PENDING:
                     // This is not an error. We're getting notified, when data arrives.
                     return;
                 case ERROR_MORE_DATA:
                     // This is not an error. The synchronous read succeeded.
                     // We're connected to a message mode pipe and the message
                     // didn't fit into the pipe's system buffer.
                     completeAsyncRead();
                     break;
                 case ERROR_PIPE_NOT_CONNECTED:
                     {
                         // It may happen, that the other side closes the connection directly
                         // after writing data. Then we must set the appropriate socket state.
                         pipeClosed = true;
                         Q_Q(QLocalSocket);
                         emit q->readChannelFinished();
                         return;
                     }
                 default:
                     setErrorString(QLatin1String("QLocalSocketPrivate::startAsyncRead"));
                     return;
             }
         }
     } while (!readSequenceStarted);
 }

Properties

◆ actualReadBufferSize

int QLocalSocketPrivate::actualReadBufferSize

Definition at line 147 of file qlocalsocket_p.h.

Referenced by _q_notified(), checkPipeState(), checkReadyRead(), completeAsyncRead(), and setErrorString().

◆ dataReadNotifier

QWinEventNotifier* QLocalSocketPrivate::dataReadNotifier

Definition at line 148 of file qlocalsocket_p.h.

◆ error

QLocalSocket::LocalSocketError QLocalSocketPrivate::error

Definition at line 149 of file qlocalsocket_p.h.

Referenced by destroyPipeHandles(), init(), and setErrorString().

◆ fullServerName

QString QLocalSocketPrivate::fullServerName

Definition at line 171 of file qlocalsocket_p.h.

Referenced by init().

◆ handle

HANDLE QLocalSocketPrivate::handle

Definition at line 142 of file qlocalsocket_p.h.

Referenced by checkPipeState(), completeAsyncRead(), destroyPipeHandles(), setErrorString(), and startAsyncRead().

◆ initialReadBufferSize

const qint64 QLocalSocketPrivate::initialReadBufferSize = 4096

static

Definition at line 153 of file qlocalsocket_p.h.

Referenced by startAsyncRead().

◆ overlapped

OVERLAPPED QLocalSocketPrivate::overlapped

Definition at line 143 of file qlocalsocket_p.h.

Referenced by completeAsyncRead(), startAsyncRead(), and ~QLocalSocketPrivate().

◆ pendingReadyRead

bool QLocalSocketPrivate::pendingReadyRead

Definition at line 151 of file qlocalsocket_p.h.

Referenced by _q_emitReadyRead(), _q_notified(), checkReadyRead(), and setErrorString().

◆ pipeClosed

bool QLocalSocketPrivate::pipeClosed

Definition at line 152 of file qlocalsocket_p.h.

Referenced by _q_notified(), checkPipeState(), setErrorString(), and startAsyncRead().

◆ pipeWriter

QWindowsPipeWriter* QLocalSocketPrivate::pipeWriter

Definition at line 144 of file qlocalsocket_p.h.

Referenced by setErrorString().

◆ readBuffer

QRingBuffer QLocalSocketPrivate::readBuffer

Definition at line 146 of file qlocalsocket_p.h.

Referenced by completeAsyncRead(), and startAsyncRead().

◆ readBufferMaxSize

qint64 QLocalSocketPrivate::readBufferMaxSize

Definition at line 145 of file qlocalsocket_p.h.

Referenced by setErrorString(), and startAsyncRead().

◆ readSequenceStarted

bool QLocalSocketPrivate::readSequenceStarted

Definition at line 150 of file qlocalsocket_p.h.

Referenced by completeAsyncRead(), setErrorString(), and startAsyncRead().

◆ serverName

QString QLocalSocketPrivate::serverName

Definition at line 170 of file qlocalsocket_p.h.