diff options
author | 2022-04-12 02:26:34 +0200 | |
---|---|---|
committer | 2022-04-12 02:26:34 +0200 | |
commit | dca3cf8c5bd804bf563fd43a6cdfdb1a5b85d490 (patch) | |
tree | 56a21e7f928fd20da792772d8a899c7f3df64db7 /include/libimobiledevice/service.h | |
parent | ea6084c4ed624b6191b4b47737e33d88911bebc8 (diff) | |
download | libimobiledevice-dca3cf8c5bd804bf563fd43a6cdfdb1a5b85d490.tar.gz libimobiledevice-dca3cf8c5bd804bf563fd43a6cdfdb1a5b85d490.tar.bz2 |
Documentation fixes
Diffstat (limited to 'include/libimobiledevice/service.h')
-rw-r--r-- | include/libimobiledevice/service.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/include/libimobiledevice/service.h b/include/libimobiledevice/service.h index 13d0e15..6842054 100644 --- a/include/libimobiledevice/service.h +++ b/include/libimobiledevice/service.h | |||
@@ -42,9 +42,10 @@ typedef enum { | |||
42 | SERVICE_E_UNKNOWN_ERROR = -256 | 42 | SERVICE_E_UNKNOWN_ERROR = -256 |
43 | } service_error_t; | 43 | } service_error_t; |
44 | 44 | ||
45 | typedef struct service_client_private service_client_private; | 45 | typedef struct service_client_private service_client_private; /**< \private */ |
46 | typedef service_client_private* service_client_t; /**< The client handle. */ | 46 | typedef service_client_private* service_client_t; /**< The client handle. */ |
47 | 47 | ||
48 | /** service constructor cast */ | ||
48 | #define SERVICE_CONSTRUCTOR(x) (int32_t (*)(idevice_t, lockdownd_service_descriptor_t, void**))(x) | 49 | #define SERVICE_CONSTRUCTOR(x) (int32_t (*)(idevice_t, lockdownd_service_descriptor_t, void**))(x) |
49 | 50 | ||
50 | /* Interface */ | 51 | /* Interface */ |
@@ -74,6 +75,8 @@ service_error_t service_client_new(idevice_t device, lockdownd_service_descripto | |||
74 | * use. | 75 | * use. |
75 | * @param label The label to use for communication. Usually the program name. | 76 | * @param label The label to use for communication. Usually the program name. |
76 | * Pass NULL to disable sending the label in requests to lockdownd. | 77 | * Pass NULL to disable sending the label in requests to lockdownd. |
78 | * @param constructor_func Constructor function for the service client to create (e.g. afc_client_new()) | ||
79 | * @param error_code Pointer to an int32_t that will receive the service start error code. | ||
77 | * | 80 | * |
78 | * @return SERVICE_E_SUCCESS on success, or a SERVICE_E_* error code | 81 | * @return SERVICE_E_SUCCESS on success, or a SERVICE_E_* error code |
79 | * otherwise. | 82 | * otherwise. |
@@ -160,7 +163,7 @@ service_error_t service_enable_ssl(service_client_t client); | |||
160 | /** | 163 | /** |
161 | * Disable SSL for the given service client. | 164 | * Disable SSL for the given service client. |
162 | * | 165 | * |
163 | * @param client The connected service client for that SSL should be disabled. | 166 | * @param client The connected service client for which SSL should be disabled. |
164 | * | 167 | * |
165 | * @return SERVICE_E_SUCCESS on success, | 168 | * @return SERVICE_E_SUCCESS on success, |
166 | * SERVICE_E_INVALID_ARG if client or client->connection is | 169 | * SERVICE_E_INVALID_ARG if client or client->connection is |
@@ -169,9 +172,11 @@ service_error_t service_enable_ssl(service_client_t client); | |||
169 | service_error_t service_disable_ssl(service_client_t client); | 172 | service_error_t service_disable_ssl(service_client_t client); |
170 | 173 | ||
171 | /** | 174 | /** |
172 | * Disable SSL for the given service client without sending SSL terminate messages. | 175 | * Disable SSL for the given service client, optionally without sending SSL terminate messages. |
173 | * | 176 | * |
174 | * @param client The connected service client for that SSL should be disabled. | 177 | * @param client The connected service client for which SSL should be disabled. |
178 | * @param sslBypass A boolean value indicating wether to disable SSL with a proper | ||
179 | * SSL shutdown (0), or bypass the shutdown (1). | ||
175 | * | 180 | * |
176 | * @return SERVICE_E_SUCCESS on success, | 181 | * @return SERVICE_E_SUCCESS on success, |
177 | * SERVICE_E_INVALID_ARG if client or client->connection is | 182 | * SERVICE_E_INVALID_ARG if client or client->connection is |