1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNetwork module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QLOCALSERVER_H
41#define QLOCALSERVER_H
42
43#include <QtNetwork/qtnetworkglobal.h>
44#include <QtNetwork/qabstractsocket.h>
45
46QT_REQUIRE_CONFIG(localserver);
47
48QT_BEGIN_NAMESPACE
49
50class QLocalSocket;
51class QLocalServerPrivate;
52
53class Q_NETWORK_EXPORT QLocalServer : public QObject
54{
55 Q_OBJECT
56 Q_DECLARE_PRIVATE(QLocalServer)
57 Q_PROPERTY(SocketOptions socketOptions READ socketOptions WRITE setSocketOptions)
58
59Q_SIGNALS:
60 void newConnection();
61
62public:
63 enum SocketOption {
64 NoOptions = 0x0,
65 UserAccessOption = 0x01,
66 GroupAccessOption = 0x2,
67 OtherAccessOption = 0x4,
68 WorldAccessOption = 0x7
69 };
70 Q_FLAG(SocketOption)
71 Q_DECLARE_FLAGS(SocketOptions, SocketOption)
72 Q_FLAG(SocketOptions)
73
74 explicit QLocalServer(QObject *parent = nullptr);
75 ~QLocalServer();
76
77 void close();
78 QString errorString() const;
79 virtual bool hasPendingConnections() const;
80 bool isListening() const;
81 bool listen(const QString &name);
82 bool listen(qintptr socketDescriptor);
83 int maxPendingConnections() const;
84 virtual QLocalSocket *nextPendingConnection();
85 QString serverName() const;
86 QString fullServerName() const;
87 static bool removeServer(const QString &name);
88 QAbstractSocket::SocketError serverError() const;
89 void setMaxPendingConnections(int numConnections);
90 bool waitForNewConnection(int msec = 0, bool *timedOut = nullptr);
91
92 void setSocketOptions(SocketOptions options);
93 SocketOptions socketOptions() const;
94
95 qintptr socketDescriptor() const;
96
97protected:
98 virtual void incomingConnection(quintptr socketDescriptor);
99
100private:
101 Q_DISABLE_COPY(QLocalServer)
102 Q_PRIVATE_SLOT(d_func(), void _q_onNewConnection())
103};
104
105Q_DECLARE_OPERATORS_FOR_FLAGS(QLocalServer::SocketOptions)
106
107QT_END_NAMESPACE
108
109#endif // QLOCALSERVER_H
110
111