summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/heartbeat.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/heartbeat.h')
-rw-r--r--include/libimobiledevice/heartbeat.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/libimobiledevice/heartbeat.h b/include/libimobiledevice/heartbeat.h
index 1f5344a..42b318d 100644
--- a/include/libimobiledevice/heartbeat.h
+++ b/include/libimobiledevice/heartbeat.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 heartbeat service */
33#define HEARTBEAT_SERVICE_NAME "com.apple.mobile.heartbeat" 34#define HEARTBEAT_SERVICE_NAME "com.apple.mobile.heartbeat"
34 35
35/** Error Codes */ 36/** Error Codes */
@@ -44,7 +45,7 @@ typedef enum {
44 HEARTBEAT_E_UNKNOWN_ERROR = -256 45 HEARTBEAT_E_UNKNOWN_ERROR = -256
45} heartbeat_error_t; 46} heartbeat_error_t;
46 47
47typedef struct heartbeat_client_private heartbeat_client_private; 48typedef struct heartbeat_client_private heartbeat_client_private; /**< \private */
48typedef heartbeat_client_private *heartbeat_client_t; /**< The client handle. */ 49typedef heartbeat_client_private *heartbeat_client_t; /**< The client handle. */
49 50
50/** 51/**
@@ -116,7 +117,7 @@ heartbeat_error_t heartbeat_receive(heartbeat_client_t client, plist_t * plist);
116 * @param client The heartbeat client to use for receiving 117 * @param client The heartbeat client to use for receiving
117 * @param plist pointer to a plist_t that will point to the received plist 118 * @param plist pointer to a plist_t that will point to the received plist
118 * upon successful return 119 * upon successful return
119 * @param timeout Maximum time in milliseconds to wait for data. 120 * @param timeout_ms Maximum time in milliseconds to wait for data.
120 * 121 *
121 * @return HEARTBEAT_E_SUCCESS on success, 122 * @return HEARTBEAT_E_SUCCESS on success,
122 * HEARTBEAT_E_INVALID_ARG when client or *plist is NULL, 123 * HEARTBEAT_E_INVALID_ARG when client or *plist is NULL,