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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the tools applications 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef COMMUNICATIONSTARTER_H
#define COMMUNICATIONSTARTER_H
#include "symbianutils_global.h"
#include <QtCore/QSharedPointer>
#include <QtCore/QObject>
namespace trk {
class TrkDevice;
class BluetoothListener;
struct BaseCommunicationStarterPrivate;
/* BaseCommunicationStarter: A QObject that repeatedly tries to open a
* trk device until a connection succeeds or a timeout occurs (emitting
* signals), allowing to do something else in the foreground (local event loop
* [say QMessageBox] or some asynchronous operation). If the initial
* connection attempt in start() fails, the
* virtual initializeStartupResources() is called to initialize resources
* required to pull up the communication (namely Bluetooth listeners).
* The base class can be used as is to prompt the user to launch App TRK for a
* serial communication as this requires no further resource setup. */
class SYMBIANUTILS_EXPORT BaseCommunicationStarter : public QObject {
Q_OBJECT
Q_DISABLE_COPY(BaseCommunicationStarter)
public:
typedef QSharedPointer<TrkDevice> TrkDevicePtr;
enum State { Running, Connected, TimedOut };
explicit BaseCommunicationStarter(const TrkDevicePtr& trkDevice, QObject *parent = 0);
virtual ~BaseCommunicationStarter();
int intervalMS() const;
void setIntervalMS(int i);
int attempts() const;
void setAttempts(int a);
QString device() const;
State state() const;
QString errorString() const;
enum StartResult {
Started, // Starter is now running.
ConnectionSucceeded, /* Initial connection attempt succeeded,
* no need to keep running. */
StartError // Error occurred during start.
};
StartResult start();
signals:
void connected();
void timeout();
void message(const QString &);
private slots:
void slotTimer();
protected:
virtual bool initializeStartupResources(QString *errorMessage);
private:
inline void stopTimer();
BaseCommunicationStarterPrivate *d;
};
/* AbstractBluetoothStarter: Repeatedly tries to open a trk Bluetooth
* device. Note that in case a Listener is already running mode, the
* connection will succeed immediately.
* initializeStartupResources() is implemented to fire up the listener.
* Introduces a new virtual createListener() that derived classes must
* implement as a factory function that creates and sets up the
* listener (mode, message connection, etc). */
class SYMBIANUTILS_EXPORT AbstractBluetoothStarter : public BaseCommunicationStarter {
Q_OBJECT
Q_DISABLE_COPY(AbstractBluetoothStarter)
public:
protected:
explicit AbstractBluetoothStarter(const TrkDevicePtr& trkDevice, QObject *parent = 0);
// Implemented to fire up the listener.
virtual bool initializeStartupResources(QString *errorMessage);
// New virtual: Overwrite to create and parametrize the listener.
virtual BluetoothListener *createListener() = 0;
};
/* ConsoleBluetoothStarter: Convenience class for console processes. Creates a
* listener in "Listen" mode with the messages redirected to standard output. */
class SYMBIANUTILS_EXPORT ConsoleBluetoothStarter : public AbstractBluetoothStarter {
Q_OBJECT
Q_DISABLE_COPY(ConsoleBluetoothStarter)
public:
static bool startBluetooth(const TrkDevicePtr& trkDevice,
QObject *listenerParent,
int attempts,
QString *errorMessage);
protected:
virtual BluetoothListener *createListener();
private:
explicit ConsoleBluetoothStarter(const TrkDevicePtr& trkDevice,
QObject *listenerParent,
QObject *parent = 0);
QObject *m_listenerParent;
};
} // namespace trk
#endif // COMMUNICATIONSTARTER_H
|
