aboutsummaryrefslogtreecommitdiffstats
path: root/examples/androidextras/services/servicesameprocess/doc/src/qtandroidextras-example-service-same-process.qdoc
blob: 9183aca80171bde7a8d4eec627054466349b1096 (plain)
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
/****************************************************************************
**
** 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 Native Android Service in Same Process
    \ingroup examples-qtandroidextras
    \example services/servicesameprocess
    \brief Demonstrates how to run an Android service in the main process,
           and how to communicate between QML/C++ and a Java service.

    \image androidservices.png

    This example demonstrates how to create and run a simple Android service in
    the same process as the main activity \c QtActivity, and then exchange data
    between QML/C++ and the Java service. This service is a pure Java
    implementation.

    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, 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/servicesameprocess/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java
    \skipto package
    \printuntil /^\}/

    In the overwritten method
    \l{Android: Service onStartCommand}{onStartCommand()}, the service receives a
    name from the calling intent, then calls 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}.

    \section1 Manage the AndroidManifest.xml File

    To use the service, it must be declared in the \c AndroidManifest.xml
    file. When using pure Android Service in the main app process, use the following:

    \quotefromfile services/servicesameprocess/android/AndroidManifest.xml
    \skipto <service
    \printuntil </service>

    \section1 Start the Service

    Before starting the service, register the native methods, then call the
    \l{Android: Service startService}{startService()} method, as follows:

    \quotefromfile services/servicesameprocess/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.

    Then, you have to add the necessary \l Connections, as described in
    \l{Qt JNI Messenger}{Qt JNI Messenger Example}.

    \sa {Android Services}, {Qt for Android}, {Qt Android Extras}
*/