diff options
author | Assam Boudjelthia <assam.boudjelthia@qt.io> | 2020-04-07 14:29:09 +0300 |
---|---|---|
committer | Assam Boudjelthia <assam.boudjelthia@qt.io> | 2020-05-25 17:14:38 +0300 |
commit | 79f643e6f9f91015e18605854161e96ed12730a3 (patch) | |
tree | 9b67d23637cb51bf62ee3e92ed18c5ee51871e74 | |
parent | 9dc12a9289d542fabed8a30ad347ed80e471f93b (diff) |
Add Android Service examples with Remote Objects
Additional service examples with communication using Qt Remote Objects.
Task-number: QTBUG-83038
Change-Id: I6451c816681e314bd4f47c8966c5d98cd225e64d
Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
(cherry picked from commit d560ad9f356e2f5912b0ebabde4c001efcb9b31f)
18 files changed, 1127 insertions, 2 deletions
diff --git a/examples/androidextras/services/common/common_ro.pri b/examples/androidextras/services/common/common_ro.pri new file mode 100644 index 0000000..eacfc6d --- /dev/null +++ b/examples/androidextras/services/common/common_ro.pri @@ -0,0 +1,3 @@ +INCLUDEPATH += $$PWD + +HEADERS += $$PWD/qtandroidservice_ro.h diff --git a/examples/androidextras/services/common/main.qml b/examples/androidextras/services/common/main.qml index 862df96..848cb19 100644 --- a/examples/androidextras/services/common/main.qml +++ b/examples/androidextras/services/common/main.qml @@ -1,5 +1,3 @@ - - /**************************************************************************** ** ** Copyright (C) 2020 The Qt Company Ltd. diff --git a/examples/androidextras/services/common/qtandroidservice.rep b/examples/androidextras/services/common/qtandroidservice.rep new file mode 100644 index 0000000..6b9d676 --- /dev/null +++ b/examples/androidextras/services/common/qtandroidservice.rep @@ -0,0 +1,4 @@ +class QtAndroidService { + SLOT(void sendToService(const QString &name)); + SIGNAL(messageFromService(const QString &message)); +} diff --git a/examples/androidextras/services/common/qtandroidservice_ro.h b/examples/androidextras/services/common/qtandroidservice_ro.h new file mode 100644 index 0000000..8e53fb1 --- /dev/null +++ b/examples/androidextras/services/common/qtandroidservice_ro.h @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +#include "rep_qtandroidservice_source.h" + +class QtAndroidService : public QtAndroidServiceSource +{ +public slots: + void sendToService(const QString &name) override { + emit messageFromService("Hello " + name); + }; +}; diff --git a/examples/androidextras/services/serviceremoteobjects/android/AndroidManifest.xml b/examples/androidextras/services/serviceremoteobjects/android/AndroidManifest.xml new file mode 100644 index 0000000..7894045 --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/android/AndroidManifest.xml @@ -0,0 +1,106 @@ +<?xml version="1.0"?> +<manifest package="org.qtproject.example.qtandroidservice" xmlns:android="http://schemas.android.com/apk/res/android" android:versionName="-- %%INSERT_VERSION_NAME%% --" android:versionCode="-- %%INSERT_VERSION_CODE%% --" android:installLocation="auto"> + <uses-sdk android:minSdkVersion="21" android:targetSdkVersion="28"/> + + <!-- The following comment will be replaced upon deployment with default permissions based on the dependencies of the application. + Remove the comment if you do not require these default permissions. --> + <!-- %%INSERT_PERMISSIONS --> + + <!-- The following comment will be replaced upon deployment with default features based on the dependencies of the application. + Remove the comment if you do not require these default features. --> + <!-- %%INSERT_FEATURES --> + + <supports-screens android:largeScreens="true" android:normalScreens="true" android:anyDensity="true" android:smallScreens="true"/> + + <application android:hardwareAccelerated="true" android:name="org.qtproject.qt5.android.bindings.QtApplication" android:label="-- %%INSERT_APP_NAME%% --" android:extractNativeLibs="true"> + <activity android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|layoutDirection|locale|fontScale|keyboard|keyboardHidden|navigation|mcc|mnc|density" android:name="org.qtproject.qt5.android.bindings.QtActivity" android:label="-- %%INSERT_APP_NAME%% --" android:screenOrientation="unspecified" android:launchMode="singleTop"> + <intent-filter> + <action android:name="android.intent.action.MAIN"/> + <category android:name="android.intent.category.LAUNCHER"/> + </intent-filter> + + <!-- Application arguments --> + <!-- meta-data android:name="android.app.arguments" android:value="arg1 arg2 arg3"/ --> + <!-- Application arguments --> + + <meta-data android:name="android.app.lib_name" android:value="-- %%INSERT_APP_LIB_NAME%% --"/> + <meta-data android:name="android.app.qt_sources_resource_id" android:resource="@array/qt_sources"/> + <meta-data android:name="android.app.repository" android:value="default"/> + <meta-data android:name="android.app.qt_libs_resource_id" android:resource="@array/qt_libs"/> + <meta-data android:name="android.app.bundled_libs_resource_id" android:resource="@array/bundled_libs"/> + <!-- Deploy Qt libs as part of package --> + <meta-data android:name="android.app.bundle_local_qt_libs" android:value="-- %%BUNDLE_LOCAL_QT_LIBS%% --"/> + + <!-- Run with local libs --> + <meta-data android:name="android.app.use_local_qt_libs" android:value="-- %%USE_LOCAL_QT_LIBS%% --"/> + <meta-data android:name="android.app.libs_prefix" android:value="/data/local/tmp/qt/"/> + <meta-data android:name="android.app.load_local_libs_resource_id" android:resource="@array/load_local_libs"/> + <meta-data android:name="android.app.load_local_jars" android:value="-- %%INSERT_LOCAL_JARS%% --"/> + <meta-data android:name="android.app.static_init_classes" android:value="-- %%INSERT_INIT_CLASSES%% --"/> + <!-- Used to specify custom system library path to run with local system libs --> + <!-- <meta-data android:name="android.app.system_libs_prefix" android:value="/system/lib/"/> --> + <!-- Messages maps --> + <meta-data android:value="@string/ministro_not_found_msg" android:name="android.app.ministro_not_found_msg"/> + <meta-data android:value="@string/ministro_needed_msg" android:name="android.app.ministro_needed_msg"/> + <meta-data android:value="@string/fatal_error_msg" android:name="android.app.fatal_error_msg"/> + <meta-data android:value="@string/unsupported_android_version" android:name="android.app.unsupported_android_version"/> + <!-- Messages maps --> + + <!-- Splash screen --> + <!-- Orientation-specific (portrait/landscape) data is checked first. If not available for current orientation, + then android.app.splash_screen_drawable. For best results, use together with splash_screen_sticky and + use hideSplashScreen() with a fade-out animation from Qt Android Extras to hide the splash screen when you + are done populating your window with content. --> + <!-- meta-data android:name="android.app.splash_screen_drawable_portrait" android:resource="@drawable/logo_portrait" / --> + <!-- meta-data android:name="android.app.splash_screen_drawable_landscape" android:resource="@drawable/logo_landscape" / --> + <!-- meta-data android:name="android.app.splash_screen_drawable" android:resource="@drawable/logo"/ --> + <!-- meta-data android:name="android.app.splash_screen_sticky" android:value="true"/ --> + <!-- Splash screen --> + + <!-- Background running --> + <!-- Warning: changing this value to true may cause unexpected crashes if the + application still try to draw after + "applicationStateChanged(Qt::ApplicationSuspended)" + signal is sent! --> + <meta-data android:name="android.app.background_running" android:value="false"/> + <!-- Background running --> + + <!-- auto screen scale factor --> + <meta-data android:name="android.app.auto_screen_scale_factor" android:value="false"/> + <!-- auto screen scale factor --> + + <!-- extract android style --> + <!-- available android:values : + * default - In most cases this will be the same as "full", but it can also be something else if needed, e.g., for compatibility reasons + * full - useful QWidget & Quick Controls 1 apps + * minimal - useful for Quick Controls 2 apps, it is much faster than "full" + * none - useful for apps that don't use any of the above Qt modules + --> + <meta-data android:name="android.app.extract_android_style" android:value="default"/> + <!-- extract android style --> + </activity> + + <service android:process=":qt_service" android:name=".QtAndroidService"> + + <meta-data android:name="android.app.lib_name" android:value="service"/> + <meta-data android:name="android.app.qt_sources_resource_id" android:resource="@array/qt_sources"/> + <meta-data android:name="android.app.repository" android:value="default"/> + <meta-data android:name="android.app.qt_libs_resource_id" android:resource="@array/qt_libs"/> + <meta-data android:name="android.app.bundled_libs_resource_id" android:resource="@array/bundled_libs"/> + <!-- Deploy Qt libs as part of package --> + <meta-data android:name="android.app.bundle_local_qt_libs" android:value="-- %%BUNDLE_LOCAL_QT_LIBS%% --"/> + + <!-- Run with local libs --> + <meta-data android:name="android.app.use_local_qt_libs" android:value="-- %%USE_LOCAL_QT_LIBS%% --"/> + <meta-data android:name="android.app.libs_prefix" android:value="/data/local/tmp/qt/"/> + <meta-data android:name="android.app.load_local_libs_resource_id" android:resource="@array/load_local_libs"/> + <meta-data android:name="android.app.load_local_jars" android:value="-- %%INSERT_LOCAL_JARS%% --"/> + <meta-data android:name="android.app.static_init_classes" android:value="-- %%INSERT_INIT_CLASSES%% --"/> + <!-- Run with local libs --> + + <!-- Background running --> + <meta-data android:name="android.app.background_running" android:value="true"/> + <!-- Background running --> + </service> + </application> +</manifest> diff --git a/examples/androidextras/services/serviceremoteobjects/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java b/examples/androidextras/services/serviceremoteobjects/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java new file mode 100644 index 0000000..b378fcb --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +package org.qtproject.example.qtandroidservice; + +import android.content.Context; +import android.content.Intent; +import org.qtproject.qt5.android.bindings.QtService; +import android.util.Log; + +public class QtAndroidService extends QtService { + + private static final String TAG = "QtAndroidService"; + + @Override + public void onCreate() { + super.onCreate(); + Log.i(TAG, "Creating Service"); + } + + @Override + public void onDestroy() { + super.onDestroy(); + Log.i(TAG, "Destroying Service"); + } +} diff --git a/examples/androidextras/services/serviceremoteobjects/doc/src/qtandroidextras-example-service-remoteobjects.qdoc b/examples/androidextras/services/serviceremoteobjects/doc/src/qtandroidextras-example-service-remoteobjects.qdoc new file mode 100644 index 0000000..667f31b --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/doc/src/qtandroidextras-example-service-remoteobjects.qdoc @@ -0,0 +1,183 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \title Android Service with Qt Remote Objects + \ingroup examples-qtandroidextras + \example services/serviceremoteobjects + \brief Demonstrates how to run an Android service in a separate process, + and how to communicate between the service process and the main process + using Qt Remote Objects. + + \image androidservices.png + + This example demonstrates how to create and run an Android service in + a separate process from the main application process, and then exchange data + between QML/C++ and the Java service using \l{Qt Remote Objects}. + + 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 + + To start a service in its own process, extend the \c QtService class for + your service. Extending \c QtService allows the service to load the necessary + Qt libraries used for Qt, like \l{Qt Remote Objects} libraries. + + Start by creating the Java service class. The following class extends \c QtService + and acts as your service entry point: + + \quotefromfile services/serviceremoteobjects/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java + \skipto package + \printuntil /^\}/ + + This class can have any logic you want using Java code. However, you don't need + any logic to communicate with Qt as that will be done using Qt Remote Objects. + + \section1 Manage the AndroidManifest.xml File + + To use the service, it must be declared in the \c AndroidManifest.xml + file as follows: + + \quotefromfile services/serviceremoteobjects/android/AndroidManifest.xml + \skipto <service + \printuntil </service> + + The important part of this service declaration is the \c lib_name part. + It will ensure that the service is run by the service's own lib file: + + \quotefromfile services/serviceremoteobjects/android/AndroidManifest.xml + \skipto android:value="service" + \printuntil android:value="service" + + \section1 Handle the Application Start + + To start the service, call the following function from the application's + \c main(): + + \quotefromfile services/serviceremoteobjects/main.cpp + \skipto startService + \printuntil /^\}/ + + \section1 Handle the Service Start + + \l{QAndroidService} is used to create the service process. For the service + to start from its own \c .so lib file, create a sub-project with the following + \c .pro file: + + \quotefromfile services/serviceremoteobjects/service.pro + \printuntil CONFIG + + \section1 Communication with Qt Remote Objects + + To use \l{Qt Remote Objects}, define a \c .rep file: + + \quotefromfile services/common/qtandroidservice.rep + \skipto class + \printuntil /^\}/ + + Define the \c .rep source file in the service project \c .pro: + + \quotefromfile services/serviceremoteobjects/service.pro + \skipto REPC_SOURCE + \printline REPC_SOURCE + + And in the application's \c .pro file: + + \quotefromfile services/serviceremoteobjects/serviceremoteobjectsclient.pro + \skipto REPC_REPLICA + \printline REPC_REPLICA + + Then define the class used by Qt Remote Objects, which has a + \c sendToService() slot and a \c messageFromService() signal: + + \quotefromfile services/common/qtandroidservice_ro.h + \skipto include + \printuntil /^\};/ + + Include the class in the previous snippet in \c main.cpp: + + \quotefromfile services/serviceremoteobjects/main.cpp + \skipto _replica.h + \printline _replica.h + + Now, in the service's \c service_main.cpp, create the \l{QRemoteObjectHost} + node and start \l{QAndroidService}: + + \quotefromfile services/serviceremoteobjects/service_main.cpp + \skipto include + \printuntil /^\}/ + + In the application's \c main.cpp, create the client node and connect it + to the source node created in the service and connect it to the QML view: + + \quotefromfile services/serviceremoteobjects/main.cpp + \skipto QRemoteObjectNode + \printuntil sendToService + + Then, add a \l Connections element to watch for the incoming messages from + the service: + + \quotefromfile services/common/main.qml + \skipto Connections + \printuntil /^\ {4}\}/ + + And set the \c onClicked for the sending button to: + + \quotefromfile services/common/main.qml + \skipto onClicked + \printline onClicked + + \sa {Android Service with Qt Remote Objects - Same Lib File}, + {Android Services}, {Qt for Android}, {Qt Android Extras} +*/ diff --git a/examples/androidextras/services/serviceremoteobjects/main.cpp b/examples/androidextras/services/serviceremoteobjects/main.cpp new file mode 100644 index 0000000..b54460a --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/main.cpp @@ -0,0 +1,91 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +#include "rep_qtandroidservice_replica.h" + +#include <QAndroidIntent> +#include <QtAndroid> + +#include <QGuiApplication> +#include <QQmlApplicationEngine> +#include <QQmlContext> + +void startService() +{ + QAndroidIntent serviceIntent(QtAndroid::androidActivity().object(), + "org/qtproject/example/qtandroidservice/QtAndroidService"); + QAndroidJniObject result = QtAndroid::androidActivity().callObjectMethod( + "startService", + "(Landroid/content/Intent;)Landroid/content/ComponentName;", + serviceIntent.handle().object()); +} + +int main(int argc, char *argv[]) +{ + QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling); + QGuiApplication app(argc, argv); + QQmlApplicationEngine engine; + + startService(); + + QRemoteObjectNode repNode; + repNode.connectToNode(QUrl(QStringLiteral("local:replica"))); + QSharedPointer<QtAndroidServiceReplica> rep(repNode.acquire<QtAndroidServiceReplica>()); + engine.rootContext()->setContextProperty("qtAndroidService", rep.data()); + bool res = rep->waitForSource(); + Q_ASSERT(res); + rep->sendToService("Qt"); + + QObject::connect(rep.data(), &QtAndroidServiceReplica::messageFromService, [](const QString &message){ + qDebug() << "Service sent: " << message; + }); + engine.load(QUrl(QLatin1String("qrc:/main.qml"))); + + return app.exec(); +} diff --git a/examples/androidextras/services/serviceremoteobjects/service.pro b/examples/androidextras/services/serviceremoteobjects/service.pro new file mode 100644 index 0000000..09a0aaa --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/service.pro @@ -0,0 +1,13 @@ +TEMPLATE = lib +TARGET = service +CONFIG += dll +QT += core androidextras remoteobjects + +SOURCES += service_main.cpp + +include(../common/common_ro.pri) + +REPC_SOURCE += ../common/qtandroidservice.rep + +target.path = $$[QT_INSTALL_EXAMPLES]/androidextras/services/serviceremoteobjects +INSTALLS += target diff --git a/examples/androidextras/services/serviceremoteobjects/service_main.cpp b/examples/androidextras/services/serviceremoteobjects/service_main.cpp new file mode 100644 index 0000000..dc1ec35 --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/service_main.cpp @@ -0,0 +1,65 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +#include "qtandroidservice_ro.h" + +#include <QDebug> +#include <QAndroidService> + +int main(int argc, char *argv[]) +{ + qWarning() << "QtAndroidService starting from separate .so"; + QAndroidService app(argc, argv); + + QRemoteObjectHost srcNode(QUrl(QStringLiteral("local:replica"))); + QtAndroidService qtAndroidService; + srcNode.enableRemoting(&qtAndroidService); + + return app.exec(); +} diff --git a/examples/androidextras/services/serviceremoteobjects/serviceremoteobjects.pro b/examples/androidextras/services/serviceremoteobjects/serviceremoteobjects.pro new file mode 100644 index 0000000..8b8b6e0 --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/serviceremoteobjects.pro @@ -0,0 +1,5 @@ +TEMPLATE = subdirs + +SUBDIRS += \ + serviceremoteobjectsclient.pro \ + service.pro diff --git a/examples/androidextras/services/serviceremoteobjects/serviceremoteobjectsclient.pro b/examples/androidextras/services/serviceremoteobjects/serviceremoteobjectsclient.pro new file mode 100644 index 0000000..75f5a2f --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjects/serviceremoteobjectsclient.pro @@ -0,0 +1,21 @@ +QT += qml quick androidextras remoteobjects + +CONFIG += c++11 + +SOURCES += main.cpp + +include(../common/common.pri) + +REPC_REPLICA += ../common/qtandroidservice.rep + +# Additional import path used to resolve QML modules in Qt Creator's code model +QML_IMPORT_PATH = + +target.path = $$[QT_INSTALL_EXAMPLES]/androidextras/services/serviceremoteobjects +INSTALLS += target + +ANDROID_PACKAGE_SOURCE_DIR = $$PWD/android + +DISTFILES += \ + android/AndroidManifest.xml \ + android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java diff --git a/examples/androidextras/services/serviceremoteobjectssamelib/android/AndroidManifest.xml b/examples/androidextras/services/serviceremoteobjectssamelib/android/AndroidManifest.xml new file mode 100644 index 0000000..daca3a6 --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjectssamelib/android/AndroidManifest.xml @@ -0,0 +1,110 @@ +<?xml version="1.0"?> +<manifest package="org.qtproject.example.qtandroidservice" xmlns:android="http://schemas.android.com/apk/res/android" android:versionName="-- %%INSERT_VERSION_NAME%% --" android:versionCode="-- %%INSERT_VERSION_CODE%% --" android:installLocation="auto"> + <uses-sdk android:minSdkVersion="21" android:targetSdkVersion="28"/> + + <!-- The following comment will be replaced upon deployment with default permissions based on the dependencies of the application. + Remove the comment if you do not require these default permissions. --> + <!-- %%INSERT_PERMISSIONS --> + + <!-- The following comment will be replaced upon deployment with default features based on the dependencies of the application. + Remove the comment if you do not require these default features. --> + <!-- %%INSERT_FEATURES --> + + <supports-screens android:largeScreens="true" android:normalScreens="true" android:anyDensity="true" android:smallScreens="true"/> + + <application android:hardwareAccelerated="true" android:name="org.qtproject.qt5.android.bindings.QtApplication" android:label="-- %%INSERT_APP_NAME%% --" android:extractNativeLibs="true"> + <activity android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|layoutDirection|locale|fontScale|keyboard|keyboardHidden|navigation|mcc|mnc|density" android:name="org.qtproject.qt5.android.bindings.QtActivity" android:label="-- %%INSERT_APP_NAME%% --" android:screenOrientation="unspecified" android:launchMode="singleTop"> + <intent-filter> + <action android:name="android.intent.action.MAIN"/> + <category android:name="android.intent.category.LAUNCHER"/> + </intent-filter> + + <!-- Application arguments --> + <!-- meta-data android:name="android.app.arguments" android:value="arg1 arg2 arg3"/ --> + <!-- Application arguments --> + + <meta-data android:name="android.app.lib_name" android:value="-- %%INSERT_APP_LIB_NAME%% --"/> + <meta-data android:name="android.app.qt_sources_resource_id" android:resource="@array/qt_sources"/> + <meta-data android:name="android.app.repository" android:value="default"/> + <meta-data android:name="android.app.qt_libs_resource_id" android:resource="@array/qt_libs"/> + <meta-data android:name="android.app.bundled_libs_resource_id" android:resource="@array/bundled_libs"/> + <!-- Deploy Qt libs as part of package --> + <meta-data android:name="android.app.bundle_local_qt_libs" android:value="-- %%BUNDLE_LOCAL_QT_LIBS%% --"/> + + <!-- Run with local libs --> + <meta-data android:name="android.app.use_local_qt_libs" android:value="-- %%USE_LOCAL_QT_LIBS%% --"/> + <meta-data android:name="android.app.libs_prefix" android:value="/data/local/tmp/qt/"/> + <meta-data android:name="android.app.load_local_libs_resource_id" android:resource="@array/load_local_libs"/> + <meta-data android:name="android.app.load_local_jars" android:value="-- %%INSERT_LOCAL_JARS%% --"/> + <meta-data android:name="android.app.static_init_classes" android:value="-- %%INSERT_INIT_CLASSES%% --"/> + <!-- Used to specify custom system library path to run with local system libs --> + <!-- <meta-data android:name="android.app.system_libs_prefix" android:value="/system/lib/"/> --> + <!-- Messages maps --> + <meta-data android:value="@string/ministro_not_found_msg" android:name="android.app.ministro_not_found_msg"/> + <meta-data android:value="@string/ministro_needed_msg" android:name="android.app.ministro_needed_msg"/> + <meta-data android:value="@string/fatal_error_msg" android:name="android.app.fatal_error_msg"/> + <meta-data android:value="@string/unsupported_android_version" android:name="android.app.unsupported_android_version"/> + <!-- Messages maps --> + + <!-- Splash screen --> + <!-- Orientation-specific (portrait/landscape) data is checked first. If not available for current orientation, + then android.app.splash_screen_drawable. For best results, use together with splash_screen_sticky and + use hideSplashScreen() with a fade-out animation from Qt Android Extras to hide the splash screen when you + are done populating your window with content. --> + <!-- meta-data android:name="android.app.splash_screen_drawable_portrait" android:resource="@drawable/logo_portrait" / --> + <!-- meta-data android:name="android.app.splash_screen_drawable_landscape" android:resource="@drawable/logo_landscape" / --> + <!-- meta-data android:name="android.app.splash_screen_drawable" android:resource="@drawable/logo"/ --> + <!-- meta-data android:name="android.app.splash_screen_sticky" android:value="true"/ --> + <!-- Splash screen --> + + <!-- Background running --> + <!-- Warning: changing this value to true may cause unexpected crashes if the + application still try to draw after + "applicationStateChanged(Qt::ApplicationSuspended)" + signal is sent! --> + <meta-data android:name="android.app.background_running" android:value="false"/> + <!-- Background running --> + + <!-- auto screen scale factor --> + <meta-data android:name="android.app.auto_screen_scale_factor" android:value="false"/> + <!-- auto screen scale factor --> + + <!-- extract android style --> + <!-- available android:values : + * default - In most cases this will be the same as "full", but it can also be something else if needed, e.g., for compatibility reasons + * full - useful QWidget & Quick Controls 1 apps + * minimal - useful for Quick Controls 2 apps, it is much faster than "full" + * none - useful for apps that don't use any of the above Qt modules + --> + <meta-data android:name="android.app.extract_android_style" android:value="default"/> + <!-- extract android style --> + </activity> + + <service android:process=":qt_service" android:name=".QtAndroidService"> + + <!-- Application arguments --> + <meta-data android:name="android.app.arguments" android:value="-service"/> + <!-- Application arguments --> + + <meta-data android:name="android.app.lib_name" android:value="-- %%INSERT_APP_LIB_NAME%% --"/> + <meta-data android:name="android.app.qt_sources_resource_id" android:resource="@array/qt_sources"/> + <meta-data android:name="android.app.repository" android:value="default"/> + <meta-data android:name="android.app.qt_libs_resource_id" android:resource="@array/qt_libs"/> + <meta-data android:name="android.app.bundled_libs_resource_id" android:resource="@array/bundled_libs"/> + <!-- Deploy Qt libs as part of package --> + <meta-data android:name="android.app.bundle_local_qt_libs" android:value="-- %%BUNDLE_LOCAL_QT_LIBS%% --"/> + + <!-- Run with local libs --> + <meta-data android:name="android.app.use_local_qt_libs" android:value="-- %%USE_LOCAL_QT_LIBS%% --"/> + <meta-data android:name="android.app.libs_prefix" android:value="/data/local/tmp/qt/"/> + <meta-data android:name="android.app.load_local_libs_resource_id" android:resource="@array/load_local_libs"/> + <meta-data android:name="android.app.load_local_jars" android:value="-- %%INSERT_LOCAL_JARS%% --"/> + <meta-data android:name="android.app.static_init_classes" android:value="-- %%INSERT_INIT_CLASSES%% --"/> + <!-- Run with local libs --> + + <!-- Background running --> + <meta-data android:name="android.app.background_running" android:value="true"/> + <!-- Background running --> + </service> + </application> +</manifest> diff --git a/examples/androidextras/services/serviceremoteobjectssamelib/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java b/examples/androidextras/services/serviceremoteobjectssamelib/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java new file mode 100644 index 0000000..a4c44d6 --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjectssamelib/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +package org.qtproject.example.qtandroidservice; + +import android.content.Context; +import android.content.Intent; +import org.qtproject.qt5.android.bindings.QtService; +import android.util.Log; + +public class QtAndroidService extends QtService +{ + private static final String TAG = "QtAndroidService"; + + @Override + public void onCreate() { + Log.i(TAG, "Creating Service"); + super.onCreate(); + } + + @Override + public void onDestroy() { + Log.i(TAG, "Destroying Service"); + super.onDestroy(); + } +} diff --git a/examples/androidextras/services/serviceremoteobjectssamelib/doc/src/qtandroidextras-example-service-remoteobjects-samelib.qdoc b/examples/androidextras/services/serviceremoteobjectssamelib/doc/src/qtandroidextras-example-service-remoteobjects-samelib.qdoc new file mode 100644 index 0000000..91feaeb --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjectssamelib/doc/src/qtandroidextras-example-service-remoteobjects-samelib.qdoc @@ -0,0 +1,189 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \target android service with remote object in same lib + \title Android Service with Qt Remote Objects - Same Lib File + \ingroup examples-qtandroidextras + \example services/serviceremoteobjectssamelib + \brief Demonstrates how to run an Android service in a separate process using + the same lib file, and how to communicate between the service process + and the main process using Qt Remote Objects. + + \image androidservices.png + + This example demonstrates how to create and run an Android service in + a separate process from the main application process, and then exchange data + between QML/C++ and the Java service using \l{Qt Remote Objects}. + + 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 + + To start a service in its own process, you can extend the \c QtService class + for your service. Extending \c QtService allows the service to load the + necessary Qt libraries used for Qt, like \l{Qt Remote Objects} libraries. + + Start by creating the Java service class. The following class extends \c QtService + and acts as your service entry point: + + \quotefromfile services/serviceremoteobjectssamelib/android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java + \skipto package + \printuntil /^\}/ + + This class can have any logic you want using Java code. However, you don't need + any logic to communicate with Qt as that will be done using Qt Remote Objects. + + \section1 Manage the AndroidManifest.xml File + + To be able to use the service, it must be declared in the \c AndroidManifest.xml + file as follows: + + \quotefromfile services/serviceremoteobjectssamelib/android/AndroidManifest.xml + \skipto <service + \printuntil </service> + + The important parts of this service declaration are the \c arguments and \c lib_name + parts. Those will ensure that the service is run by executing the lib file + of the main activity with the argument \c -service: + + \quotefromfile services/serviceremoteobjectssamelib/android/AndroidManifest.xml + \skipto <service + \skipto <!-- Application arguments --> + \printuntil lib_name + + \section1 Handle the Application Start + + Since the same \c .so lib file is being used for the application and the + service, you need to handle both scenarios in the \c main() function. No + arguments are provided to start the main application, and therefore you must + add the following in the \c main() function: + + \quotefromfile services/serviceremoteobjectssamelib/main.cpp + \skipto (argc + \printline (argc + + Then calling the following function starts the service: + + \quotefromfile services/serviceremoteobjectssamelib/main.cpp + \skipto startService + \printuntil /^\}/ + + \section1 Handle the Service Start + + \l{QAndroidService} is used to create the service process. The main .so lib + file will be called with an argument to start the service if you add the + following code: + + \quotefromfile services/serviceremoteobjectssamelib/main.cpp + \skipto else if + \printline else if + + \section1 Communication with Qt Remote Objects + + To use \l{Qt Remote Objects}, define a \c .rep file: + + \quotefromfile services/common/qtandroidservice.rep + \skipto class + \printuntil /^\}/ + + Define the \c .rep source and replica file in your project \c .pro file as follows: + + \quotefromfile services/serviceremoteobjectssamelib/serviceremoteobjectssamelib.pro + \skipto REPC_SOURCE + \printuntil REPC_REPLICA + + Then define the class used by Qt Remote Objects, which has a + \c sendToService() slot and a \c messageFromService() signal: + + \quotefromfile services/common/qtandroidservice_ro.h + \skipto include + \printuntil /^\};/ + + Include the class in the previous snippet in \c main.cpp: + + \quotefromfile services/serviceremoteobjectssamelib/main.cpp + \skipto _replica.h + \printline _replica.h + + Now, inside the service handling part, create the \l{QRemoteObjectHost} + node: + + \quotefromfile services/serviceremoteobjectssamelib/main.cpp + \skipto QRemoteObjectHost + \printuntil enableRemoting + + Then, in the application handling part, create the client node and connect it + to the source node created in the service and connect it to the QML view: + + \quotefromfile services/serviceremoteobjectssamelib/main.cpp + \skipto QRemoteObjectNode + \printuntil sendToService + + Then, add a \l Connections element to watch for the incoming messages from + the service: + + \quotefromfile services/common/main.qml + \skipto Connections + \printuntil /^\ {4}\}/ + + And set the \c onClicked for the sending button to: + + \quotefromfile services/common/main.qml + \skipto onClicked + \printline onClicked + + \sa {Android Service with Qt Remote Objects}, {Android Services}, + {Qt for Android}, {Qt Android Extras} +*/ diff --git a/examples/androidextras/services/serviceremoteobjectssamelib/main.cpp b/examples/androidextras/services/serviceremoteobjectssamelib/main.cpp new file mode 100644 index 0000000..8f85cbd --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjectssamelib/main.cpp @@ -0,0 +1,106 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +#include "rep_qtandroidservice_replica.h" +#include "qtandroidservice_ro.h" + +#include <QAndroidIntent> +#include <QtAndroid> +#include <QAndroidService> + +#include <QGuiApplication> +#include <QQmlApplicationEngine> +#include <QQmlContext> + +void startService() +{ + QAndroidIntent serviceIntent(QtAndroid::androidActivity().object(), + "org/qtproject/example/qtandroidservice/QtAndroidService"); + QAndroidJniObject result = QtAndroid::androidActivity().callObjectMethod( + "startService", + "(Landroid/content/Intent;)Landroid/content/ComponentName;", + serviceIntent.handle().object()); +} + +int main(int argc, char *argv[]) +{ + if (argc <= 1) { + QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling); + QGuiApplication app(argc, argv); + QQmlApplicationEngine engine; + + startService(); + + QRemoteObjectNode repNode; + repNode.connectToNode(QUrl(QStringLiteral("local:replica"))); + QSharedPointer<QtAndroidServiceReplica> rep(repNode.acquire<QtAndroidServiceReplica>()); + engine.rootContext()->setContextProperty("qtAndroidService", rep.data()); + bool res = rep->waitForSource(); + Q_ASSERT(res); + rep->sendToService("Qt"); + + engine.load(QUrl(QLatin1String("qrc:/main.qml"))); + + return app.exec(); + + } else if (argc > 1 && strcmp(argv[1], "-service") == 0) { + qWarning() << "QtAndroidService starting from same .so"; + QAndroidService app(argc, argv); + + QRemoteObjectHost srcNode(QUrl(QStringLiteral("local:replica"))); + QtAndroidService qtAndroidService; + srcNode.enableRemoting(&qtAndroidService); + + return app.exec(); + + } else { + qWarning() << "Unrecognized command line argument"; + return -1; + } +} diff --git a/examples/androidextras/services/serviceremoteobjectssamelib/serviceremoteobjectssamelib.pro b/examples/androidextras/services/serviceremoteobjectssamelib/serviceremoteobjectssamelib.pro new file mode 100644 index 0000000..3975a19 --- /dev/null +++ b/examples/androidextras/services/serviceremoteobjectssamelib/serviceremoteobjectssamelib.pro @@ -0,0 +1,23 @@ +QT += qml quick androidextras remoteobjects + +CONFIG += c++11 + +SOURCES += main.cpp + +include(../common/common_ro.pri) +include(../common/common.pri) + +REPC_SOURCE += ../common/qtandroidservice.rep +REPC_REPLICA += ../common/qtandroidservice.rep + +# Additional import path used to resolve QML modules in Qt Creator's code model +QML_IMPORT_PATH = + +target.path = $$[QT_INSTALL_EXAMPLES]/androidextras/services/serviceremoteobjectssamelib +INSTALLS += target + +ANDROID_PACKAGE_SOURCE_DIR = $$PWD/android + +DISTFILES += \ + android/AndroidManifest.xml \ + android/src/org/qtproject/example/qtandroidservice/QtAndroidService.java diff --git a/examples/androidextras/services/services.pro b/examples/androidextras/services/services.pro index 1e6b5b9..0d567d6 100644 --- a/examples/androidextras/services/services.pro +++ b/examples/androidextras/services/services.pro @@ -5,3 +5,9 @@ SUBDIRS += \ servicebinder \ servicebroadcast \ servicebroadcastsamelib + +qtHaveModule(remoteobjects) { + SUBDIRS += \ + serviceremoteobjects \ + serviceremoteobjectssamelib +} |