/**************************************************************************** ** ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). ** All rights reserved. ** Contact: http://www.qt-project.org/ ** ** This file is part of the QtNetwork module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** GNU Lesser General Public License Usage ** This file may be used under the terms of the GNU Lesser General Public ** License version 2.1 as published by the Free Software Foundation and ** appearing in the file LICENSE.LGPL included in the packaging of this ** file. Please review the following information to ensure the GNU Lesser ** General Public License version 2.1 requirements will be met: ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Nokia gives you certain additional ** rights. These rights are described in the Nokia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU General ** Public License version 3.0 as published by the Free Software Foundation ** and appearing in the file LICENSE.GPL included in the packaging of this ** file. Please review the following information to ensure the GNU General ** Public License version 3.0 requirements will be met: ** http://www.gnu.org/copyleft/gpl.html. ** ** Other Usage ** Alternatively, this file may be used in accordance with the terms and ** conditions contained in a signed written agreement between you and Nokia. ** ** ** ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qlocalsocket_p.h" #include #include #include QT_BEGIN_NAMESPACE void QLocalSocketPrivate::init() { Q_Q(QLocalSocket); pipeReader = new QWindowsPipeReader(q); q->connect(pipeReader, SIGNAL(readyRead()), SIGNAL(readyRead())); q->connect(pipeReader, SIGNAL(pipeClosed()), SLOT(_q_pipeClosed()), Qt::QueuedConnection); q->connect(pipeReader, SIGNAL(winError(ulong, const QString &)), SLOT(_q_winError(ulong, const QString &))); } void QLocalSocketPrivate::setErrorString(const QString &function) { DWORD windowsError = GetLastError(); _q_winError(windowsError, function); } void QLocalSocketPrivate::_q_winError(ulong windowsError, const QString &function) { Q_Q(QLocalSocket); 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 && currentState != QLocalSocket::ConnectingState) q->emit disconnected(); } emit q->error(error); } QLocalSocketPrivate::QLocalSocketPrivate() : QIODevicePrivate(), handle(INVALID_HANDLE_VALUE), pipeReader(0), pipeWriter(0), error(QLocalSocket::UnknownSocketError), state(QLocalSocket::UnconnectedState) { } QLocalSocketPrivate::~QLocalSocketPrivate() { destroyPipeHandles(); } void QLocalSocketPrivate::destroyPipeHandles() { if (handle != INVALID_HANDLE_VALUE) { DisconnectNamedPipe(handle); CloseHandle(handle); } } void QLocalSocket::connectToServer(const QString &name, OpenMode openMode) { Q_D(QLocalSocket); if (state() == ConnectedState || state() == ConnectingState) { setErrorString(tr("Trying to connect while connection is in progress")); emit error(QLocalSocket::OperationError); return; } d->error = QLocalSocket::UnknownSocketError; d->errorString = QString(); d->state = ConnectingState; emit stateChanged(d->state); if (name.isEmpty()) { d->error = QLocalSocket::ServerNotFoundError; setErrorString(QLocalSocket::tr("%1: Invalid name").arg(QLatin1String("QLocalSocket::connectToServer"))); d->state = UnconnectedState; emit error(d->error); emit stateChanged(d->state); return; } QString pipePath = QLatin1String("\\\\.\\pipe\\"); if (name.startsWith(pipePath)) d->fullServerName = name; else d->fullServerName = pipePath + name; // Try to open a named pipe HANDLE localSocket; forever { DWORD permissions = (openMode & QIODevice::ReadOnly) ? GENERIC_READ : 0; permissions |= (openMode & QIODevice::WriteOnly) ? GENERIC_WRITE : 0; localSocket = CreateFile((const wchar_t *)d->fullServerName.utf16(), // pipe name permissions, 0, // no sharing NULL, // default security attributes OPEN_EXISTING, // opens existing pipe FILE_FLAG_OVERLAPPED, NULL); // no template file if (localSocket != INVALID_HANDLE_VALUE) break; DWORD error = GetLastError(); // It is really an error only if it is not ERROR_PIPE_BUSY if (ERROR_PIPE_BUSY != error) { break; } // All pipe instances are busy, so wait until connected or up to 5 seconds. if (!WaitNamedPipe((const wchar_t *)d->fullServerName.utf16(), 5000)) break; } if (localSocket == INVALID_HANDLE_VALUE) { d->setErrorString(QLatin1String("QLocalSocket::connectToServer")); d->fullServerName = QString(); return; } // we have a valid handle d->serverName = name; if (setSocketDescriptor((qintptr)localSocket, ConnectedState, openMode)) { d->handle = localSocket; emit connected(); } } // This is reading from the buffer qint64 QLocalSocket::readData(char *data, qint64 maxSize) { Q_D(QLocalSocket); return d->pipeReader->read(data, maxSize); } qint64 QLocalSocket::writeData(const char *data, qint64 maxSize) { Q_D(QLocalSocket); if (!d->pipeWriter) { d->pipeWriter = new QWindowsPipeWriter(d->handle, this); connect(d->pipeWriter, SIGNAL(canWrite()), this, SLOT(_q_canWrite())); connect(d->pipeWriter, SIGNAL(bytesWritten(qint64)), this, SIGNAL(bytesWritten(qint64))); d->pipeWriter->start(); } return d->pipeWriter->write(data, maxSize); } void QLocalSocket::abort() { Q_D(QLocalSocket); if (d->pipeWriter) { delete d->pipeWriter; d->pipeWriter = 0; } close(); } void QLocalSocketPrivate::_q_pipeClosed() { Q_Q(QLocalSocket); if (state == QLocalSocket::UnconnectedState) return; emit q->readChannelFinished(); if (state != QLocalSocket::ClosingState) { state = QLocalSocket::ClosingState; emit q->stateChanged(state); if (state != QLocalSocket::ClosingState) return; } state = QLocalSocket::UnconnectedState; emit q->stateChanged(state); emit q->disconnected(); pipeReader->stop(); destroyPipeHandles(); handle = INVALID_HANDLE_VALUE; if (pipeWriter) { delete pipeWriter; pipeWriter = 0; } } qint64 QLocalSocket::bytesAvailable() const { Q_D(const QLocalSocket); qint64 available = QIODevice::bytesAvailable(); available += d->pipeReader->bytesAvailable(); return available; } qint64 QLocalSocket::bytesToWrite() const { Q_D(const QLocalSocket); return (d->pipeWriter) ? d->pipeWriter->bytesToWrite() : 0; } bool QLocalSocket::canReadLine() const { Q_D(const QLocalSocket); return QIODevice::canReadLine() || d->pipeReader->canReadLine(); } void QLocalSocket::close() { Q_D(QLocalSocket); if (openMode() == NotOpen) return; QIODevice::close(); d->serverName = QString(); d->fullServerName = QString(); if (state() != UnconnectedState) { if (bytesToWrite() > 0) { disconnectFromServer(); return; } d->_q_pipeClosed(); } } bool QLocalSocket::flush() { Q_D(QLocalSocket); if (d->pipeWriter) return d->pipeWriter->waitForWrite(0); return false; } void QLocalSocket::disconnectFromServer() { Q_D(QLocalSocket); // Are we still connected? if (!isValid()) { // If we have unwritten data, the pipeWriter is still present. // It must be destroyed before close() to prevent an infinite loop. delete d->pipeWriter; d->pipeWriter = 0; } flush(); if (d->pipeWriter && d->pipeWriter->bytesToWrite() != 0) { d->state = QLocalSocket::ClosingState; emit stateChanged(d->state); } else { close(); } } QLocalSocket::LocalSocketError QLocalSocket::error() const { Q_D(const QLocalSocket); return d->error; } bool QLocalSocket::setSocketDescriptor(qintptr socketDescriptor, LocalSocketState socketState, OpenMode openMode) { Q_D(QLocalSocket); d->pipeReader->stop(); d->handle = reinterpret_cast(socketDescriptor); d->state = socketState; d->pipeReader->setHandle(d->handle); QIODevice::open(openMode); emit stateChanged(d->state); if (d->state == ConnectedState && openMode.testFlag(QIODevice::ReadOnly)) d->pipeReader->startAsyncRead(); return true; } void QLocalSocketPrivate::_q_canWrite() { Q_Q(QLocalSocket); if (state == QLocalSocket::ClosingState) q->close(); } qintptr QLocalSocket::socketDescriptor() const { Q_D(const QLocalSocket); return (qintptr)d->handle; } qint64 QLocalSocket::readBufferSize() const { Q_D(const QLocalSocket); return d->pipeReader->maxReadBufferSize(); } void QLocalSocket::setReadBufferSize(qint64 size) { Q_D(QLocalSocket); d->pipeReader->setMaxReadBufferSize(size); } bool QLocalSocket::waitForConnected(int msecs) { Q_UNUSED(msecs); return (state() == ConnectedState); } bool QLocalSocket::waitForDisconnected(int msecs) { Q_D(QLocalSocket); if (state() == UnconnectedState) return false; if (!openMode().testFlag(QIODevice::ReadOnly)) { qWarning("QLocalSocket::waitForDisconnected isn't supported for write only pipes."); return false; } if (d->pipeReader->waitForPipeClosed(msecs)) { d->_q_pipeClosed(); return true; } return false; } bool QLocalSocket::isValid() const { Q_D(const QLocalSocket); return d->handle != INVALID_HANDLE_VALUE; } bool QLocalSocket::waitForReadyRead(int msecs) { Q_D(QLocalSocket); if (bytesAvailable() > 0) return true; if (d->state != QLocalSocket::ConnectedState) return false; // We already know that the pipe is gone, but did not enter the event loop yet. if (d->pipeReader->isPipeClosed()) { d->_q_pipeClosed(); return false; } bool result = d->pipeReader->waitForReadyRead(msecs); // We just noticed that the pipe is gone. if (d->pipeReader->isPipeClosed()) d->_q_pipeClosed(); return result; } bool QLocalSocket::waitForBytesWritten(int msecs) { Q_D(const QLocalSocket); if (!d->pipeWriter) return false; // Wait for the pipe writer to acknowledge that it has // written. This will succeed if either the pipe writer has // already written the data, or if it manages to write data // within the given timeout. return d->pipeWriter->waitForWrite(msecs); } QT_END_NAMESPACE