qlocalserver.cpp

Go to the documentation of this file.

// 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"
#include "qlocalsocket.h"
 
#if defined(Q_OS_WIN) && !defined(QT_LOCALSOCKET_TCP)
#include <QtCore/qt_windows.h>
#endif
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
QLocalServer::QLocalServer(QObject *parent)
        : QObject(*new QLocalServerPrivate, parent)
{
    Q_D(QLocalServer);
    d->init();
}
 
QLocalServer::~QLocalServer()
{
    if (isListening())
        close();
}
 
void QLocalServer::setSocketOptions(SocketOptions options)
{
    Q_D(QLocalServer);
 
    d->socketOptions = options;
}
 
QLocalServer::SocketOptions QLocalServer::socketOptions() const
{
    Q_D(const QLocalServer);
    return d->socketOptions;
}
 
QBindable<QLocalServer::SocketOptions> QLocalServer::bindableSocketOptions()
{
    Q_D(QLocalServer);
    return &d->socketOptions;
}
 
qintptr QLocalServer::socketDescriptor() const
{
    Q_D(const QLocalServer);
    if (!isListening())
        return -1;
#if defined(QT_LOCALSOCKET_TCP)
    return d->tcpServer.socketDescriptor();
#elif defined(Q_OS_WIN)
    const auto handle = d->connectionEventNotifier->handle();
    return handle != INVALID_HANDLE_VALUE ? qintptr(handle) : -1;
#else
    return d->socketNotifier->socket();
#endif
}
 
void QLocalServer::close()
{
    Q_D(QLocalServer);
    if (!isListening())
        return;
    qDeleteAll(d->pendingConnections);
    d->pendingConnections.clear();
    d->closeServer();
    d->serverName.clear();
    d->fullServerName.clear();
    d->errorString.clear();
    d->error = QAbstractSocket::UnknownSocketError;
}
 
QString QLocalServer::errorString() const
{
    Q_D(const QLocalServer);
    return d->errorString;
}
 
bool QLocalServer::hasPendingConnections() const
{
    Q_D(const QLocalServer);
    return !(d->pendingConnections.isEmpty());
}
 
void QLocalServer::incomingConnection(quintptr socketDescriptor)
{
    QLocalSocket *socket = new QLocalSocket(this);
    socket->setSocketDescriptor(socketDescriptor);
    addPendingConnection(socket);
}
 
void QLocalServer::addPendingConnection(QLocalSocket *socket)
{
    Q_D(QLocalServer);
    d->pendingConnections.enqueue(socket);
    emit newConnection();
}
 
bool QLocalServer::isListening() const
{
    Q_D(const QLocalServer);
    return !(d->serverName.isEmpty());
}
 
bool QLocalServer::listen(const QString &name)
{
    Q_D(QLocalServer);
    if (isListening()) {
        qWarning("QLocalServer::listen() called when already listening");
        return false;
    }
 
    if (name.isEmpty()) {
        d->error = QAbstractSocket::HostNotFoundError;
        QString function = "QLocalServer::listen"_L1;
        d->errorString = tr("%1: Name error").arg(function);
        return false;
    }
 
    if (!d->listen(name)) {
        d->serverName.clear();
        d->fullServerName.clear();
        return false;
    }
 
    d->serverName = name;
    return true;
}
 
bool QLocalServer::listen(qintptr socketDescriptor)
{
    Q_D(QLocalServer);
    if (isListening()) {
        qWarning("QLocalServer::listen() called when already listening");
        return false;
    }
 
    d->serverName.clear();
    d->fullServerName.clear();
 
    if (!d->listen(socketDescriptor)) {
        return false;
    }
 
    return true;
}
 
int QLocalServer::maxPendingConnections() const
{
    Q_D(const QLocalServer);
    return d->maxPendingConnections;
}
 
QLocalSocket *QLocalServer::nextPendingConnection()
{
    Q_D(QLocalServer);
    if (d->pendingConnections.isEmpty())
        return nullptr;
    QLocalSocket *nextSocket = d->pendingConnections.dequeue();
#ifndef QT_LOCALSOCKET_TCP
    if (d->pendingConnections.size() <= d->maxPendingConnections)
#ifndef Q_OS_WIN
        d->socketNotifier->setEnabled(true);
#else
        d->connectionEventNotifier->setEnabled(true);
#endif
#endif
    return nextSocket;
}
 
bool QLocalServer::removeServer(const QString &name)
{
    return QLocalServerPrivate::removeServer(name);
}
 
QString QLocalServer::serverName() const
{
    Q_D(const QLocalServer);
    return d->serverName;
}
 
QString QLocalServer::fullServerName() const
{
    Q_D(const QLocalServer);
    return d->fullServerName;
}
 
QAbstractSocket::SocketError QLocalServer::serverError() const
{
    Q_D(const QLocalServer);
    return d->error;
}
 
void QLocalServer::setMaxPendingConnections(int numConnections)
{
    Q_D(QLocalServer);
    d->maxPendingConnections = numConnections;
}
 
bool QLocalServer::waitForNewConnection(int msec, bool *timedOut)
{
    Q_D(QLocalServer);
    if (timedOut)
        *timedOut = false;
 
    if (!isListening())
        return false;
 
    d->waitForNewConnection(msec, timedOut);
 
    return !d->pendingConnections.isEmpty();
}
 
void QLocalServer::setListenBacklogSize(int size)
{
    Q_D(QLocalServer);
    d->listenBacklog = size;
}
 
int QLocalServer::listenBacklogSize() const
{
    Q_D(const QLocalServer);
    return d->listenBacklog;
}
 
QT_END_NAMESPACE
 
#include "moc_qlocalserver.cpp"