diff options
Diffstat (limited to 'src/network/socket/qlocalserver.cpp')
| -rw-r--r-- | src/network/socket/qlocalserver.cpp | 114 |
1 files changed, 70 insertions, 44 deletions
diff --git a/src/network/socket/qlocalserver.cpp b/src/network/socket/qlocalserver.cpp index 16dc907149..5ef2db6b94 100644 --- a/src/network/socket/qlocalserver.cpp +++ b/src/network/socket/qlocalserver.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtNetwork module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qlocalserver.h" #include "qlocalserver_p.h" @@ -47,6 +11,8 @@ QT_BEGIN_NAMESPACE +using namespace Qt::StringLiterals; + /*! \class QLocalServer \since 4.4 @@ -90,6 +56,8 @@ QT_BEGIN_NAMESPACE socket. This changes the access permissions on platforms (Linux, Windows) that support access permissions on the socket. Both GroupAccess and OtherAccess may vary slightly in meanings depending on the platform. + On Linux and Android it is possible to use sockets with abstract addresses; + socket permissions have no meaning for such sockets. \value NoOptions No access restrictions have been set. \value UserAccessOption @@ -102,6 +70,10 @@ QT_BEGIN_NAMESPACE Access is available to everyone on Windows. \value WorldAccessOption No access restrictions. + \value AbstractNamespaceOption + The listening socket will be created in the abstract namespace. This flag is specific to Linux. + In case of other platforms, for the sake of code portability, this flag is equivalent + to WorldAccessOption. \sa socketOptions */ @@ -148,7 +120,7 @@ QLocalServer::~QLocalServer() In some cases, such as with Unix domain sockets on Linux, the access to the socket will be determined by file system permissions, and are created based on the umask. Setting the access flags will - overide this and will restrict or permit access as specified. + override this and will restrict or permit access as specified. Other Unix-based operating systems, such as \macos, do not honor file permissions for Unix domain sockets and by default @@ -161,6 +133,11 @@ QLocalServer::~QLocalServer() in the Windows documentation). OtherAccessOption refers to the well known "Everyone" group. + On Linux platforms it is possible to create a socket in the abstract + namespace, which is independent of the filesystem. Using this kind + of socket implies ignoring permission options. On other platforms + AbstractNamespaceOption is equivalent to WorldAccessOption. + By default none of the flags are set, access permissions are the platform default. @@ -199,8 +176,7 @@ QBindable<QLocalServer::SocketOptions> QLocalServer::bindableSocketOptions() The type of the descriptor depends on the platform: \list \li On Windows, the returned value is a - \l{https://msdn.microsoft.com/en-us/library/windows/desktop/ms740522(v=vs.85).aspx} - {Winsock 2 Socket Handle}. + \l{Winsock 2 Socket Handle}. \li On INTEGRITY, the returned value is the QTcpServer socket descriptor and the type is defined by @@ -289,9 +265,27 @@ bool QLocalServer::hasPendingConnections() const */ void QLocalServer::incomingConnection(quintptr socketDescriptor) { - Q_D(QLocalServer); QLocalSocket *socket = new QLocalSocket(this); socket->setSocketDescriptor(socketDescriptor); + addPendingConnection(socket); +} + +/*! + This function is called by QLocalServer::incomingConnection() + to add the \a socket to the list of pending incoming connections. + + \note Don't forget to call this member from reimplemented + incomingConnection() if you do not want to break the + Pending Connections mechanism. This function emits the + pendingConnectionAvailable() signal after the socket has been + added. + + \sa incomingConnection(), pendingConnectionAvailable() + \since 6.8 +*/ +void QLocalServer::addPendingConnection(QLocalSocket *socket) +{ + Q_D(QLocalServer); d->pendingConnections.enqueue(socket); emit newConnection(); } @@ -338,7 +332,7 @@ bool QLocalServer::listen(const QString &name) if (name.isEmpty()) { d->error = QAbstractSocket::HostNotFoundError; - QString function = QLatin1String("QLocalServer::listen"); + QString function = "QLocalServer::listen"_L1; d->errorString = tr("%1: Name error").arg(function); return false; } @@ -365,7 +359,9 @@ bool QLocalServer::listen(const QString &name) serverName(), fullServerName() may return a string with a name if this option is supported by the platform; - otherwise, they return an empty QString. + otherwise, they return an empty QString. In particular, the addresses + of sockets in the abstract namespace supported by Linux will + not yield useful names if they contain unprintable characters. \sa isListening(), close() */ @@ -541,6 +537,36 @@ bool QLocalServer::waitForNewConnection(int msec, bool *timedOut) return !d->pendingConnections.isEmpty(); } +/*! + Sets the backlog queue size of to be accepted connections to \a + size. The operating system might reduce or ignore this value. + By default, the queue size is 50. + + \note This property must be set prior to calling listen(). + + \since 6.3 + + \sa listenBacklogSize() +*/ +void QLocalServer::setListenBacklogSize(int size) +{ + Q_D(QLocalServer); + d->listenBacklog = size; +} + +/*! + Returns the backlog queue size of to be accepted connections. + + \since 6.3 + + \sa setListenBacklogSize() +*/ +int QLocalServer::listenBacklogSize() const +{ + Q_D(const QLocalServer); + return d->listenBacklog; +} + QT_END_NAMESPACE #include "moc_qlocalserver.cpp" |