summaryrefslogtreecommitdiffstats
path: root/client_library/include
diff options
context:
space:
mode:
authorChristopher Wiley <wiley@google.com>2015-10-01 17:18:40 -0700
committerChristopher Wiley <wiley@google.com>2015-10-07 13:22:21 -0700
commit16daa08470beb5021b85618f1b3ee214d89e59a1 (patch)
treecd71f86a8f1e247066f55fc5cd70da2c4f17251b /client_library/include
parent5ed695ec86f5ad495e387dde02b28089839d4ea1 (diff)
downloadandroid_system_update_engine-16daa08470beb5021b85618f1b3ee214d89e59a1.tar.gz
android_system_update_engine-16daa08470beb5021b85618f1b3ee214d89e59a1.tar.bz2
android_system_update_engine-16daa08470beb5021b85618f1b3ee214d89e59a1.zip
Add DBus hiding client library
This library hides update_engine's legacy DBus dependencies until we can remove them completely. Bug: 24547247 Test: mmm system/update_engine; emerge-panther update_engine Change-Id: I7f87f2a7c31d0940c376ef43368e53b0f3bc3407
Diffstat (limited to 'client_library/include')
-rw-r--r--client_library/include/update_engine/client.h89
1 files changed, 89 insertions, 0 deletions
diff --git a/client_library/include/update_engine/client.h b/client_library/include/update_engine/client.h
new file mode 100644
index 00000000..ec39253a
--- /dev/null
+++ b/client_library/include/update_engine/client.h
@@ -0,0 +1,89 @@
+//
+// Copyright (C) 2015 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#ifndef UDPATE_ENGINE_CLIENT_LIBRARY_INCLUDE_UPDATE_ENGINE_CLIENT_H_
+#define UDPATE_ENGINE_CLIENT_LIBRARY_INCLUDE_UPDATE_ENGINE_CLIENT_H_
+
+#include <cstdint>
+#include <memory>
+#include <string>
+
+#include "update_engine/update_status.h"
+
+namespace update_engine {
+
+class UpdateEngineClient {
+ public:
+ static std::unique_ptr<UpdateEngineClient> CreateInstance();
+
+ virtual ~UpdateEngineClient() = default;
+
+ // Force the update_engine to attempt an update.
+ // |app_version|
+ // Attempt to update to this version. An empty string indicates that
+ // update engine should pick the most recent image on the current channel.
+ // |omaha_url|
+ // Force update_engine to look for updates from the given server. Passing
+ // empty indicates update_engine should get this parameter from its
+ // config. Note that update_engine will ignore this parameter in
+ // production mode to avoid pulling untrusted updates.
+ // |at_user_request|
+ // This update was directly requested by the user.
+ virtual bool AttemptUpdate(const std::string& app_version,
+ const std::string& omaha_url,
+ bool at_user_request) = 0;
+
+ // Returns the current status of the Update Engine.
+ //
+ // |out_last_checked_time|
+ // the last time the update engine checked for an update in seconds since
+ // the epoc.
+ // |out_progress|
+ // when downloading an update, this is calculated as
+ // (number of bytes received) / (total bytes).
+ // |out_update_status|
+ // See update_status.h.
+ // |out_new_version|
+ // string version of the new system image.
+ // |out_new_size|
+ // number of bytes in the new system image.
+ virtual bool GetStatus(int64_t* out_last_checked_time,
+ double* out_progress,
+ UpdateStatus* out_update_status,
+ std::string* out_new_version,
+ int64_t* out_new_size) = 0;
+
+ // Changes the current channel of the device to the target channel.
+ virtual bool SetTargetChannel(const std::string& target_channel) = 0;
+
+ // Get the channel the device will switch to on reboot.
+ virtual bool GetTargetChannel(std::string* out_channel) = 0;
+
+ // Get the channel the device is currently on.
+ virtual bool GetChannel(std::string* out_channel) = 0;
+
+ protected:
+ // Use CreateInstance().
+ UpdateEngineClient() = default;
+
+ private:
+ UpdateEngineClient(const UpdateEngineClient&) = delete;
+ void operator=(const UpdateEngineClient&) = delete;
+}; // class UpdateEngineClient
+
+} // namespace update_engine
+
+#endif // UDPATE_ENGINE_CLIENT_LIBRARY_INCLUDE_UPDATE_ENGINE_CLIENT_H_