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
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtAndroidExtras module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/
/*!
\title Android Service with BroadcastReceiver
\ingroup examples-qtandroidextras
\example services/servicebroadcast
\brief Demonstrates how to run an Android service in a separate process using
a separate .so lib file, and how to communicate with Qt using a BroadcastReceiver.
\image androidservices.png
This example demonstrates how to create and run an Android service in a
separate process that uses a separate \c .so lib file, and then exchange data
between QML/C++ and the Java service using a
\l{Android: BroadcastReceiver}{BroadcastReceiver}.
When clicking the \uicontrol {Send to Service} button, the name entered in the QML
view, Qt, in this case, is sent to the Android service. Then, the service
replies back with a message \c {Hello Qt} which is printed in the QML view.
\include examples-run.qdocinc
\section1 Create the Service
When running the app's process, you can extend either \c QtService or \c Service.
Extending \c QtService allows Qt to load all the necessary libraries to load
Qt components correctly and call native methods on Android. However, here
the service is running in the same process, and with the BroadcastReceiver
you don't need native calls to exchange messages with Qt, so extending either
class works.
Start by creating the Java service class. This is a normal Android \c Service
that receives a name from QML and replies back with \c {Hello <name>}:
\quotefromfile services/servicebroadcast/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java
\skipto package
\printuntil /^\}/
In the owerwritten method
\l{Android: Service onStartCommand}{onStartCommand()}, the service receives
a name from the calling intent, then sends a broadcast to the BroadcastReceiver,
which in turn will call the native method \c {sendToQt(String message)}. For
more information on managing native calls in Qt, see
\l{Calling QML/C++ Functions from Java Code}.
Since the service is run on a separate \c .so lib file, you must create a
sub-project for the service process which uses \l{QAndroidService}. Start
with a \c .pro file as follows:
\quotefromfile services/servicebroadcast/service.pro
\printuntil service_main
Then, create the file \c service_main.cpp:
\quotefromfile services/servicebroadcast/service_main.cpp
\skipto include
\printuntil /^\}/
\section1 Manage the AndroidManifest.xml File
To use the service, it must be declared in the \c AndroidManifest.xml
file:
\quotefromfile services/servicebroadcast/android/AndroidManifest.xml
\skipto <service
\printuntil </service>
\section1 Start the Service
Take the following steps to set up and start the service:
\list 1
\li Register the native method
\li Create the BroadcastReceiver in a custom Java class:
\quotefromfile services/servicebroadcast/android/src/org/qtproject/example/qtandroidservice/ActivityUtils.java
\skipto package
\printuntil /^\}/
\li Register the BroadcastReceiver:
\quotefromfile services/common/qtandroidservice.cpp
\skipto :registerBroadcastReceiver
\printuntil /^\}/
\li Call the \l{Android: Service startService}{startService()}
method, as follows:
\quotefromfile services/common/qtandroidservice.cpp
\skipto sendToService
\printuntil /^\}/
This function is used to start the Service. If the service is already running,
it will only send the names without starting a new service instance.
\li Then, you have to add the necessary \l Connections, as described in
\l{Qt JNI Messenger}{Qt JNI Messenger Example}.
\endlist
\sa {Android Service with BroadcastReceiver - Same Lib File},
{Android Services}, {Qt for Android}, {Qt Android Extras}
*/
|
