summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/file_relay.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/file_relay.h')
-rw-r--r--include/libimobiledevice/file_relay.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/libimobiledevice/file_relay.h b/include/libimobiledevice/file_relay.h
index e41bb2d..6b30e65 100644
--- a/include/libimobiledevice/file_relay.h
+++ b/include/libimobiledevice/file_relay.h
@@ -32,6 +32,7 @@ extern "C" {
32#include <libimobiledevice/libimobiledevice.h> 32#include <libimobiledevice/libimobiledevice.h>
33#include <libimobiledevice/lockdown.h> 33#include <libimobiledevice/lockdown.h>
34 34
35/** Service identifier passed to lockdownd_start_service() to start the file relay service */
35#define FILE_RELAY_SERVICE_NAME "com.apple.mobile.file_relay" 36#define FILE_RELAY_SERVICE_NAME "com.apple.mobile.file_relay"
36 37
37/** Error Codes */ 38/** Error Codes */
@@ -46,7 +47,7 @@ typedef enum {
46 FILE_RELAY_E_UNKNOWN_ERROR = -256 47 FILE_RELAY_E_UNKNOWN_ERROR = -256
47} file_relay_error_t; 48} file_relay_error_t;
48 49
49typedef struct file_relay_client_private file_relay_client_private; 50typedef struct file_relay_client_private file_relay_client_private; /**< \private */
50typedef file_relay_client_private *file_relay_client_t; /**< The client handle. */ 51typedef file_relay_client_private *file_relay_client_t; /**< The client handle. */
51 52
52/** 53/**
@@ -110,8 +111,7 @@ file_relay_error_t file_relay_client_free(file_relay_client_t client);
110 * data using idevice_connection_receive(). The connection will be closed 111 * data using idevice_connection_receive(). The connection will be closed
111 * automatically by the device, but use file_relay_client_free() to clean 112 * automatically by the device, but use file_relay_client_free() to clean
112 * up properly. 113 * up properly.
113 * @param timeout Maximum time in milliseconds to wait for data. 114 *
114 *
115 * @note WARNING: Don't call this function without reading the data afterwards. 115 * @note WARNING: Don't call this function without reading the data afterwards.
116 * A directory mobile_file_relay.XXXX used for creating the archive will 116 * A directory mobile_file_relay.XXXX used for creating the archive will
117 * remain in the /tmp directory otherwise. 117 * remain in the /tmp directory otherwise.
@@ -144,6 +144,7 @@ file_relay_error_t file_relay_request_sources(file_relay_client_t client, const
144 * data using idevice_connection_receive(). The connection will be closed 144 * data using idevice_connection_receive(). The connection will be closed
145 * automatically by the device, but use file_relay_client_free() to clean 145 * automatically by the device, but use file_relay_client_free() to clean
146 * up properly. 146 * up properly.
147 * @param timeout Maximum time in milliseconds to wait for data.
147 * 148 *
148 * @note WARNING: Don't call this function without reading the data afterwards. 149 * @note WARNING: Don't call this function without reading the data afterwards.
149 * A directory mobile_file_relay.XXXX used for creating the archive will 150 * A directory mobile_file_relay.XXXX used for creating the archive will