summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/companion_proxy.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/companion_proxy.h')
-rw-r--r--include/libimobiledevice/companion_proxy.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/libimobiledevice/companion_proxy.h b/include/libimobiledevice/companion_proxy.h
index 19c88eb..d786766 100644
--- a/include/libimobiledevice/companion_proxy.h
+++ b/include/libimobiledevice/companion_proxy.h
@@ -30,6 +30,7 @@ extern "C" {
30#include <libimobiledevice/libimobiledevice.h> 30#include <libimobiledevice/libimobiledevice.h>
31#include <libimobiledevice/lockdown.h> 31#include <libimobiledevice/lockdown.h>
32 32
33/** Service identifier passed to lockdownd_start_service() to start the companion proxy service */
33#define COMPANION_PROXY_SERVICE_NAME "com.apple.companion_proxy" 34#define COMPANION_PROXY_SERVICE_NAME "com.apple.companion_proxy"
34 35
35/** Error Codes */ 36/** Error Codes */
@@ -48,9 +49,10 @@ typedef enum {
48 COMPANION_PROXY_E_UNKNOWN_ERROR = -256 49 COMPANION_PROXY_E_UNKNOWN_ERROR = -256
49} companion_proxy_error_t; 50} companion_proxy_error_t;
50 51
51typedef struct companion_proxy_client_private companion_proxy_client_private; 52typedef struct companion_proxy_client_private companion_proxy_client_private; /**< \private */
52typedef companion_proxy_client_private *companion_proxy_client_t; /**< The client handle. */ 53typedef companion_proxy_client_private *companion_proxy_client_t; /**< The client handle. */
53 54
55/** Callback for companion device events */
54typedef void (*companion_proxy_device_event_cb_t) (plist_t event, void* userdata); 56typedef void (*companion_proxy_device_event_cb_t) (plist_t event, void* userdata);
55 57
56/** 58/**
@@ -119,7 +121,7 @@ companion_proxy_error_t companion_proxy_receive(companion_proxy_client_t client,
119 * Retrieves a list of paired devices. 121 * Retrieves a list of paired devices.
120 * 122 *
121 * @param client The companion_proxy client 123 * @param client The companion_proxy client
122 * @param devices Point that will receive a PLIST_ARRAY with paired device UDIDs 124 * @param paired_devices Point that will receive a PLIST_ARRAY with paired device UDIDs
123 * 125 *
124 * @note The device closes the connection after sending the reply. 126 * @note The device closes the connection after sending the reply.
125 * 127 *
@@ -161,6 +163,8 @@ companion_proxy_error_t companion_proxy_stop_listening_for_devices(companion_pro
161 * @param client The companion_proxy client 163 * @param client The companion_proxy client
162 * @param companion_udid UDID of the (paired) companion device 164 * @param companion_udid UDID of the (paired) companion device
163 * @param key The key to retrieve the value for 165 * @param key The key to retrieve the value for
166 * @param value A pointer to a plist_t that will receive the value for the given key.
167 * The consumer is responsible for freeing the value with plist_free() when no longer needed.
164 * 168 *
165 * @note The device closes the connection after sending the reply. 169 * @note The device closes the connection after sending the reply.
166 * 170 *