1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qbluetoothdevicediscoveryagent.h"
#include "qbluetoothdevicediscoveryagent_p.h"
QTM_BEGIN_NAMESPACE
/*!
\class QBluetoothDeviceDiscoveryAgent
\brief The QBluetoothDeviceDiscoveryAgent class provides an API for discovering nearby
Bluetooth devices.
\ingroup connectivity-bluetooth
\inmodule QtConnectivity
To discovery nearby Bluetooth devices create an instance of QBluetoothDeviceDiscoveryAgent,
connect to either the deviceDiscovered() or finished() signals and call start().
\snippet snippets/connectivity/devicediscovery.cpp Device discovery
To retrieve results asynchronously connect to the deviceDiscovered() signal. To get a list of
all discovered devices call discoveredDevices() after the finished() signal is emitted.
*/
/*!
\enum QBluetoothDeviceDiscoveryAgent::Error
Indicates all possible error conditions found during Bluetooth device discovery.
\value NoError No error has occurred.
\value PoweredOff Bluetooth adaptor is powered off, power it on before doing discovery.
\value IOFailure Writing or reading from device resulted in an error.
\value UnknownError An unknown error has occurred.
*/
/*!
\enum QBluetoothDeviceDiscoveryAgent::InquiryType
This enum describes the inquiry type used when discovering Bluetooth devices.
\value GeneralUnlimitedInquiry A general unlimited inquiry. Discovers all visible Bluetooth
devices in the local vicinity.
\value LimitedInquiry A limited inquiry. Only discovers devices that are in limited
inquiry mode. Not all platforms support limited inquiry. If
limited inquiry is requested on a platform that does not
support it general unlimited inquiry we be used instead. Setting
LimitedInquiry is useful for 2 games that wish to find each other
quickly. The phone scans for devices in LimitedInquiry and
Service Discovery is only done on one or two devices speeding up the
service scan. After the game has connected the device returns to
GeneralUnilimitedInquiry
*/
/*!
\fn void QBluetoothDeviceDiscoveryAgent::deviceDiscovered(const QBluetoothDeviceInfo &info)
This signal is emitted when the Bluetooth device described by \a info is discovered.
*/
/*!
\fn void QBluetoothDeviceDiscoveryAgent::finished()
This signal is emitted when Bluetooth device discovery completes.
*/
/*!
\fn void QBluetoothDeviceDiscoveryAgent::error(QBluetoothDeviceDiscoveryAgent::Error error)
This signal is emitted when an \a error occurs during Bluetooth device discovery.
\sa error(), errorString()
*/
/*!
\fn void QBluetoothDeviceDiscoveryAgent::canceled()
This signal is emitted when device discovery is aborted by a call to stop().
*/
/*!
\fn bool QBluetoothDeviceDiscoveryAgent::isActive() const
Returns true if the agent is currently discovering Bluetooth devices, other returns false.
*/
/*!
Constructs a new Bluetooth device discovery agent with parent \a parent.
*/
QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(QObject *parent)
: QObject(parent), d_ptr(new QBluetoothDeviceDiscoveryAgentPrivate)
{
d_ptr->q_ptr = this;
}
/*!
Destructor for ~QBluetoothDeviceDiscoveryAgent()
*/
QBluetoothDeviceDiscoveryAgent::~QBluetoothDeviceDiscoveryAgent()
{
delete d_ptr;
}
/*!
\property QBluetoothDeviceDiscoveryAgent::inquiryType
\brief type of inquiry scan to use when discovering devices
This property affects the type of inquiry scan which is performed when discovering devices.
By default, this property is set to GeneralUnlimitedInquiry.
Not all platforms support LimitedInquiry.
\sa InquiryType
*/
QBluetoothDeviceDiscoveryAgent::InquiryType QBluetoothDeviceDiscoveryAgent::inquiryType() const
{
Q_D(const QBluetoothDeviceDiscoveryAgent);
return d->inquiryType;
}
void QBluetoothDeviceDiscoveryAgent::setInquiryType(QBluetoothDeviceDiscoveryAgent::InquiryType type)
{
Q_D(QBluetoothDeviceDiscoveryAgent);
d->inquiryType = type;
}
/*!
Returns a list of all discovered Bluetooth devices.
*/
QList<QBluetoothDeviceInfo> QBluetoothDeviceDiscoveryAgent::discoveredDevices() const
{
Q_D(const QBluetoothDeviceDiscoveryAgent);
return d->discoveredDevices;
}
/*!
Starts Bluetooth device discovery, if it is not already started.
The deviceDiscovered() signal is emitted as each device is discovered. The finished() signal
is emitted once device discovery is complete.
*/
void QBluetoothDeviceDiscoveryAgent::start()
{
Q_D(QBluetoothDeviceDiscoveryAgent);
if (!isActive())
d->start();
}
/*!
Stops Bluetooth device discovery. The cancel() signal is emitted once the
device discovery is canceled. start() maybe called before the cancel signal is
received. Once start() has been called the cancel signal from the prior
discovery will be silently discarded.
*/
void QBluetoothDeviceDiscoveryAgent::stop()
{
Q_D(QBluetoothDeviceDiscoveryAgent);
if (isActive())
d->stop();
}
bool QBluetoothDeviceDiscoveryAgent::isActive() const
{
Q_D(const QBluetoothDeviceDiscoveryAgent);
return d->isActive();
}
/*!
Returns the last error which has occurred.
*/
QBluetoothDeviceDiscoveryAgent::Error QBluetoothDeviceDiscoveryAgent::error() const
{
Q_D(const QBluetoothDeviceDiscoveryAgent);
return d->lastError;
}
/*!
Returns a human-readable description of the last error that occurred.
*/
QString QBluetoothDeviceDiscoveryAgent::errorString() const
{
Q_D(const QBluetoothDeviceDiscoveryAgent);
return d->errorString;
}
#include "moc_qbluetoothdevicediscoveryagent.cpp"
QTM_END_NAMESPACE
|
