1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Copyright (C) 2014 Denis Shienkov <denis.shienkov@gmail.com>
5** Contact: https://www.qt.io/licensing/
6**
7** This file is part of the QtBluetooth module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial License Usage
11** Licensees holding valid commercial Qt licenses may use this file in
12** accordance with the commercial license agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and The Qt Company. For licensing terms
15** and conditions see https://www.qt.io/terms-conditions. For further
16** information use the contact form at https://www.qt.io/contact-us.
17**
18** GNU Lesser General Public License Usage
19** Alternatively, this file may be used under the terms of the GNU Lesser
20** General Public License version 3 as published by the Free Software
21** Foundation and appearing in the file LICENSE.LGPL3 included in the
22** packaging of this file. Please review the following information to
23** ensure the GNU Lesser General Public License version 3 requirements
24** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
25**
26** GNU General Public License Usage
27** Alternatively, this file may be used under the terms of the GNU
28** General Public License version 2.0 or (at your option) the GNU General
29** Public license version 3 or any later version approved by the KDE Free
30** Qt Foundation. The licenses are as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
32** included in the packaging of this file. Please review the following
33** information to ensure the GNU General Public License requirements will
34** be met: https://www.gnu.org/licenses/gpl-2.0.html and
35** https://www.gnu.org/licenses/gpl-3.0.html.
36**
37** $QT_END_LICENSE$
38**
39****************************************************************************/
40
41#ifndef QBLUETOOTHDEVICEDISCOVERYAGENT_H
42#define QBLUETOOTHDEVICEDISCOVERYAGENT_H
43
44#include <QtBluetooth/qtbluetoothglobal.h>
45
46#include <QtCore/QObject>
47#include <QtBluetooth/QBluetoothDeviceInfo>
48#include <QtBluetooth/QBluetoothAddress>
49
50QT_BEGIN_NAMESPACE
51
52class QBluetoothDeviceDiscoveryAgentPrivate;
53
54class Q_BLUETOOTH_EXPORT QBluetoothDeviceDiscoveryAgent : public QObject
55{
56 Q_OBJECT
57 Q_PROPERTY(QBluetoothDeviceDiscoveryAgent::InquiryType inquiryType
58 READ inquiryType WRITE setInquiryType)
59
60public:
61 // FIXME: add more errors
62 // FIXME: add bluez error handling
63 enum Error {
64 NoError,
65 InputOutputError,
66 PoweredOffError,
67 InvalidBluetoothAdapterError,
68 UnsupportedPlatformError,
69 UnsupportedDiscoveryMethod,
70 UnknownError = 100 // New errors must be added before Unknown error
71 };
72 Q_ENUM(Error)
73
74 enum InquiryType {
75 GeneralUnlimitedInquiry,
76 LimitedInquiry
77 };
78 Q_ENUM(InquiryType)
79
80 enum DiscoveryMethod
81 {
82 NoMethod = 0x0,
83 ClassicMethod = 0x01,
84 LowEnergyMethod = 0x02,
85 };
86 Q_DECLARE_FLAGS(DiscoveryMethods, DiscoveryMethod)
87 Q_FLAG(DiscoveryMethods)
88
89 explicit QBluetoothDeviceDiscoveryAgent(QObject *parent = nullptr);
90 explicit QBluetoothDeviceDiscoveryAgent(const QBluetoothAddress &deviceAdapter,
91 QObject *parent = nullptr);
92 ~QBluetoothDeviceDiscoveryAgent();
93
94 // TODO Remove inquiry type in Qt 6 -> not really used anywhere
95 QBluetoothDeviceDiscoveryAgent::InquiryType inquiryType() const;
96 void setInquiryType(QBluetoothDeviceDiscoveryAgent::InquiryType type);
97
98 bool isActive() const;
99
100 Error error() const;
101 QString errorString() const;
102
103 QList<QBluetoothDeviceInfo> discoveredDevices() const;
104
105 void setLowEnergyDiscoveryTimeout(int msTimeout);
106 int lowEnergyDiscoveryTimeout() const;
107
108 static DiscoveryMethods supportedDiscoveryMethods();
109public Q_SLOTS:
110 void start();
111 void start(DiscoveryMethods method);
112 void stop();
113
114Q_SIGNALS:
115 void deviceDiscovered(const QBluetoothDeviceInfo &info);
116 void deviceUpdated(const QBluetoothDeviceInfo &info, QBluetoothDeviceInfo::Fields updatedFields);
117 void finished();
118 void error(QBluetoothDeviceDiscoveryAgent::Error error);
119 void canceled();
120
121private:
122 Q_DECLARE_PRIVATE(QBluetoothDeviceDiscoveryAgent)
123 QBluetoothDeviceDiscoveryAgentPrivate *d_ptr;
124};
125
126Q_DECLARE_OPERATORS_FOR_FLAGS(QBluetoothDeviceDiscoveryAgent::DiscoveryMethods)
127
128QT_END_NAMESPACE
129
130#endif
131

source code of qtconnectivity/src/bluetooth/qbluetoothdevicediscoveryagent.h