summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/lockdown.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/lockdown.h')
-rw-r--r--include/libimobiledevice/lockdown.h19
1 files changed, 10 insertions, 9 deletions
diff --git a/include/libimobiledevice/lockdown.h b/include/libimobiledevice/lockdown.h
index 1569f44..f22917a 100644
--- a/include/libimobiledevice/lockdown.h
+++ b/include/libimobiledevice/lockdown.h
@@ -80,7 +80,7 @@ typedef enum {
80 LOCKDOWN_E_UNKNOWN_ERROR = -256 80 LOCKDOWN_E_UNKNOWN_ERROR = -256
81} lockdownd_error_t; 81} lockdownd_error_t;
82 82
83typedef struct lockdownd_client_private lockdownd_client_private; 83typedef struct lockdownd_client_private lockdownd_client_private; /**< \private */
84typedef lockdownd_client_private *lockdownd_client_t; /**< The client handle. */ 84typedef lockdownd_client_private *lockdownd_client_t; /**< The client handle. */
85 85
86struct lockdownd_pair_record { 86struct lockdownd_pair_record {
@@ -88,19 +88,20 @@ struct lockdownd_pair_record {
88 char *host_certificate; /**< The host certificate */ 88 char *host_certificate; /**< The host certificate */
89 char *root_certificate; /**< The root certificate */ 89 char *root_certificate; /**< The root certificate */
90 char *host_id; /**< A unique HostID for the host computer */ 90 char *host_id; /**< A unique HostID for the host computer */
91 char *system_buid; /**< A unique system id */ 91 char *system_buid; /**< A unique system id */
92}; 92};
93/** A pair record holding device, host and root certificates along the host_id */ 93/** pair record holding device, host and root certificates along the host_id */
94typedef struct lockdownd_pair_record *lockdownd_pair_record_t; 94typedef struct lockdownd_pair_record *lockdownd_pair_record_t; /**< pair record */
95 95
96/** service descriptor */
96struct lockdownd_service_descriptor { 97struct lockdownd_service_descriptor {
97 uint16_t port; 98 uint16_t port; /**< port number the service was started on */
98 uint8_t ssl_enabled; 99 uint8_t ssl_enabled; /**< an indicator if the service requires SSL */
99 char* identifier; 100 char* identifier; /**< identifier of the service */
100}; 101};
101typedef struct lockdownd_service_descriptor *lockdownd_service_descriptor_t; 102typedef struct lockdownd_service_descriptor *lockdownd_service_descriptor_t;
102 103
103 104/** Callback types used in #lockdownd_cu_pairing_cb_t */
104typedef enum { 105typedef enum {
105 LOCKDOWN_CU_PAIRING_PIN_REQUESTED, /**< PIN requested: data_ptr is a char* buffer, and data_size points to the size of this buffer that must not be exceeded and has to be updated to the actual number of characters filled into the buffer. */ 106 LOCKDOWN_CU_PAIRING_PIN_REQUESTED, /**< PIN requested: data_ptr is a char* buffer, and data_size points to the size of this buffer that must not be exceeded and has to be updated to the actual number of characters filled into the buffer. */
106 LOCKDOWN_CU_PAIRING_DEVICE_INFO, /**< device information available: data_ptr is a plist_t, and data_size is ignored. The plist_t has to be copied if required, since it is freed when the callback function returns. */ 107 LOCKDOWN_CU_PAIRING_DEVICE_INFO, /**< device information available: data_ptr is a plist_t, and data_size is ignored. The plist_t has to be copied if required, since it is freed when the callback function returns. */
@@ -564,7 +565,7 @@ lockdownd_error_t lockdownd_service_descriptor_free(lockdownd_service_descriptor
564/** 565/**
565 * Gets a readable error string for a given lockdown error code. 566 * Gets a readable error string for a given lockdown error code.
566 * 567 *
567 * @params err A lockdownd error code 568 * @param err A lockdownd error code
568 * 569 *
569 * @returns A readable error string 570 * @returns A readable error string
570 */ 571 */