summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/restore.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/restore.h')
-rw-r--r--include/libimobiledevice/restore.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/include/libimobiledevice/restore.h b/include/libimobiledevice/restore.h
new file mode 100644
index 0000000..c4b5916
--- /dev/null
+++ b/include/libimobiledevice/restore.h
@@ -0,0 +1,71 @@
+/**
+ * @file libimobiledevice/restore.h
+ * @brief Implementation to communicate with the restore device daemon
+ * \internal
+ *
+ * Copyright (c) 2010 Joshua Hill. All Rights Reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef RESTORE_H
+#define RESTORE_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <libimobiledevice/libimobiledevice.h>
+
+/** @name Error Codes */
+/*@{*/
+#define RESTORE_E_SUCCESS 0
+#define RESTORE_E_INVALID_ARG -1
+#define RESTORE_E_INVALID_CONF -2
+#define RESTORE_E_PLIST_ERROR -3
+#define RESTORE_E_DICT_ERROR -4
+#define RESTORE_E_NOT_ENOUGH_DATA -5
+#define RESTORE_E_MUX_ERROR -6
+#define RESTORE_E_START_RESTORE_FAILED -7
+
+#define RESTORE_E_UNKNOWN_ERROR -256
+/*@}*/
+
+/** Represents an error code. */
+typedef int16_t restored_error_t;
+
+typedef struct restored_client_private restored_client_private;
+typedef restored_client_private *restored_client_t; /**< The client handle. */
+
+/* Interface */
+restored_error_t restored_client_new(idevice_t device, restored_client_t *client, const char *label);
+restored_error_t restored_client_free(restored_client_t client);
+
+restored_error_t restored_query_type(restored_client_t client, char **type, uint64_t *version);
+restored_error_t restored_send(restored_client_t client, plist_t plist);
+restored_error_t restored_receive(restored_client_t client, plist_t *plist);
+restored_error_t restored_goodbye(restored_client_t client);
+
+restored_error_t restored_start_restore(restored_client_t client);
+restored_error_t restored_reboot(restored_client_t client);
+
+/* Helper */
+void restored_client_set_label(restored_client_t client, const char *label);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif