summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/debugserver.h
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2024-01-31 02:57:11 +0100
committerGravatar Nikias Bassen2024-01-31 02:57:11 +0100
commit63bbac545efc400373a7f472fdd78174149119c3 (patch)
treef95c8d58b7b0fbf33bd188c5becc0401ee7e64ef /include/libimobiledevice/debugserver.h
parentf723a44513eb5ba5797da24bc2b63d9f09600a6e (diff)
downloadlibimobiledevice-63bbac545efc400373a7f472fdd78174149119c3.tar.gz
libimobiledevice-63bbac545efc400373a7f472fdd78174149119c3.tar.bz2
Move LIBIMOBILEDEVICE_API to public headers
Diffstat (limited to 'include/libimobiledevice/debugserver.h')
-rw-r--r--include/libimobiledevice/debugserver.h32
1 files changed, 16 insertions, 16 deletions
diff --git a/include/libimobiledevice/debugserver.h b/include/libimobiledevice/debugserver.h
index eaa7c48..809b97f 100644
--- a/include/libimobiledevice/debugserver.h
+++ b/include/libimobiledevice/debugserver.h
@@ -66,7 +66,7 @@ typedef debugserver_command_private *debugserver_command_t; /**< The command han
66 * @return DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when 66 * @return DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when
67 * client is NULL, or an DEBUGSERVER_E_* error code otherwise. 67 * client is NULL, or an DEBUGSERVER_E_* error code otherwise.
68 */ 68 */
69debugserver_error_t debugserver_client_new(idevice_t device, lockdownd_service_descriptor_t service, debugserver_client_t * client); 69LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_new(idevice_t device, lockdownd_service_descriptor_t service, debugserver_client_t * client);
70 70
71/** 71/**
72 * Starts a new debugserver service on the specified device and connects to it. 72 * Starts a new debugserver service on the specified device and connects to it.
@@ -81,7 +81,7 @@ debugserver_error_t debugserver_client_new(idevice_t device, lockdownd_service_d
81 * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error 81 * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error
82 * code otherwise. 82 * code otherwise.
83 */ 83 */
84debugserver_error_t debugserver_client_start_service(idevice_t device, debugserver_client_t * client, const char* label); 84LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_start_service(idevice_t device, debugserver_client_t * client, const char* label);
85 85
86/** 86/**
87 * Disconnects a debugserver client from the device and frees up the 87 * Disconnects a debugserver client from the device and frees up the
@@ -92,7 +92,7 @@ debugserver_error_t debugserver_client_start_service(idevice_t device, debugserv
92 * @return DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when 92 * @return DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when
93 * client is NULL, or an DEBUGSERVER_E_* error code otherwise. 93 * client is NULL, or an DEBUGSERVER_E_* error code otherwise.
94 */ 94 */
95debugserver_error_t debugserver_client_free(debugserver_client_t client); 95LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_free(debugserver_client_t client);
96 96
97/** 97/**
98 * Sends raw data using the given debugserver service client. 98 * Sends raw data using the given debugserver service client.
@@ -107,7 +107,7 @@ debugserver_error_t debugserver_client_free(debugserver_client_t client);
107 * invalid, or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified 107 * invalid, or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified
108 * error occurs. 108 * error occurs.
109 */ 109 */
110debugserver_error_t debugserver_client_send(debugserver_client_t client, const char* data, uint32_t size, uint32_t *sent); 110LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_send(debugserver_client_t client, const char* data, uint32_t size, uint32_t *sent);
111 111
112/** 112/**
113 * Receives raw data using the given debugserver client with specified timeout. 113 * Receives raw data using the given debugserver client with specified timeout.
@@ -125,7 +125,7 @@ debugserver_error_t debugserver_client_send(debugserver_client_t client, const c
125 * or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified 125 * or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified
126 * error occurs. 126 * error occurs.
127 */ 127 */
128debugserver_error_t debugserver_client_receive_with_timeout(debugserver_client_t client, char *data, uint32_t size, uint32_t *received, unsigned int timeout); 128LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_receive_with_timeout(debugserver_client_t client, char *data, uint32_t size, uint32_t *received, unsigned int timeout);
129 129
130/** 130/**
131 * Receives raw data from the debugserver service. 131 * Receives raw data from the debugserver service.
@@ -139,7 +139,7 @@ debugserver_error_t debugserver_client_receive_with_timeout(debugserver_client_t
139 * @return DEBUGSERVER_E_SUCCESS on success, 139 * @return DEBUGSERVER_E_SUCCESS on success,
140 * DEBUGSERVER_E_INVALID_ARG when client or plist is NULL 140 * DEBUGSERVER_E_INVALID_ARG when client or plist is NULL
141 */ 141 */
142debugserver_error_t debugserver_client_receive(debugserver_client_t client, char *data, uint32_t size, uint32_t *received); 142LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_receive(debugserver_client_t client, char *data, uint32_t size, uint32_t *received);
143 143
144/** 144/**
145 * Sends a command to the debugserver service. 145 * Sends a command to the debugserver service.
@@ -152,7 +152,7 @@ debugserver_error_t debugserver_client_receive(debugserver_client_t client, char
152 * @return DEBUGSERVER_E_SUCCESS on success, 152 * @return DEBUGSERVER_E_SUCCESS on success,
153 * DEBUGSERVER_E_INVALID_ARG when client or command is NULL 153 * DEBUGSERVER_E_INVALID_ARG when client or command is NULL
154 */ 154 */
155debugserver_error_t debugserver_client_send_command(debugserver_client_t client, debugserver_command_t command, char** response, size_t* response_size); 155LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_send_command(debugserver_client_t client, debugserver_command_t command, char** response, size_t* response_size);
156 156
157/** 157/**
158 * Receives and parses response of debugserver service. 158 * Receives and parses response of debugserver service.
@@ -164,7 +164,7 @@ debugserver_error_t debugserver_client_send_command(debugserver_client_t client,
164 * @return DEBUGSERVER_E_SUCCESS on success, 164 * @return DEBUGSERVER_E_SUCCESS on success,
165 * DEBUGSERVER_E_INVALID_ARG when client is NULL 165 * DEBUGSERVER_E_INVALID_ARG when client is NULL
166 */ 166 */
167debugserver_error_t debugserver_client_receive_response(debugserver_client_t client, char** response, size_t* response_size); 167LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_receive_response(debugserver_client_t client, char** response, size_t* response_size);
168 168
169/** 169/**
170 * Controls status of ACK mode when sending commands or receiving responses. 170 * Controls status of ACK mode when sending commands or receiving responses.
@@ -178,7 +178,7 @@ debugserver_error_t debugserver_client_receive_response(debugserver_client_t cli
178 * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error 178 * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error
179 * code otherwise. 179 * code otherwise.
180 */ 180 */
181debugserver_error_t debugserver_client_set_ack_mode(debugserver_client_t client, int enabled); 181LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_ack_mode(debugserver_client_t client, int enabled);
182 182
183/** 183/**
184 * Sets behavior when awaiting a response from the server. 184 * Sets behavior when awaiting a response from the server.
@@ -197,7 +197,7 @@ debugserver_error_t debugserver_client_set_ack_mode(debugserver_client_t client,
197 * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error 197 * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error
198 * code otherwise. 198 * code otherwise.
199 */ 199 */
200debugserver_error_t debugserver_client_set_receive_params(debugserver_client_t client, int (*cancel_receive)(), int receive_loop_timeout); 200LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_receive_params(debugserver_client_t client, int (*cancel_receive)(), int receive_loop_timeout);
201 201
202/** 202/**
203 * Sets the argv which launches an app. 203 * Sets the argv which launches an app.
@@ -210,7 +210,7 @@ debugserver_error_t debugserver_client_set_receive_params(debugserver_client_t c
210 * @return DEBUGSERVER_E_SUCCESS on success, 210 * @return DEBUGSERVER_E_SUCCESS on success,
211 * DEBUGSERVER_E_INVALID_ARG when client is NULL 211 * DEBUGSERVER_E_INVALID_ARG when client is NULL
212 */ 212 */
213debugserver_error_t debugserver_client_set_argv(debugserver_client_t client, int argc, char* argv[], char** response); 213LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_argv(debugserver_client_t client, int argc, char* argv[], char** response);
214 214
215/** 215/**
216 * Adds or sets an environment variable. 216 * Adds or sets an environment variable.
@@ -222,7 +222,7 @@ debugserver_error_t debugserver_client_set_argv(debugserver_client_t client, int
222 * @return DEBUGSERVER_E_SUCCESS on success, 222 * @return DEBUGSERVER_E_SUCCESS on success,
223 * DEBUGSERVER_E_INVALID_ARG when client is NULL 223 * DEBUGSERVER_E_INVALID_ARG when client is NULL
224 */ 224 */
225debugserver_error_t debugserver_client_set_environment_hex_encoded(debugserver_client_t client, const char* env, char** response); 225LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_environment_hex_encoded(debugserver_client_t client, const char* env, char** response);
226 226
227/** 227/**
228 * Creates and initializes a new command object. 228 * Creates and initializes a new command object.
@@ -235,7 +235,7 @@ debugserver_error_t debugserver_client_set_environment_hex_encoded(debugserver_c
235 * @return DEBUGSERVER_E_SUCCESS on success, 235 * @return DEBUGSERVER_E_SUCCESS on success,
236 * DEBUGSERVER_E_INVALID_ARG when name or command is NULL 236 * DEBUGSERVER_E_INVALID_ARG when name or command is NULL
237 */ 237 */
238debugserver_error_t debugserver_command_new(const char* name, int argc, char* argv[], debugserver_command_t* command); 238LIBIMOBILEDEVICE_API debugserver_error_t debugserver_command_new(const char* name, int argc, char* argv[], debugserver_command_t* command);
239 239
240/** 240/**
241 * Frees memory of command object. 241 * Frees memory of command object.
@@ -245,7 +245,7 @@ debugserver_error_t debugserver_command_new(const char* name, int argc, char* ar
245 * @return DEBUGSERVER_E_SUCCESS on success, 245 * @return DEBUGSERVER_E_SUCCESS on success,
246 * DEBUGSERVER_E_INVALID_ARG when command is NULL 246 * DEBUGSERVER_E_INVALID_ARG when command is NULL
247 */ 247 */
248debugserver_error_t debugserver_command_free(debugserver_command_t command); 248LIBIMOBILEDEVICE_API debugserver_error_t debugserver_command_free(debugserver_command_t command);
249 249
250/** 250/**
251 * Encodes a string into hex notation. 251 * Encodes a string into hex notation.
@@ -254,7 +254,7 @@ debugserver_error_t debugserver_command_free(debugserver_command_t command);
254 * @param encoded_buffer The buffer receives a hex encoded string 254 * @param encoded_buffer The buffer receives a hex encoded string
255 * @param encoded_length Length of the hex encoded string 255 * @param encoded_length Length of the hex encoded string
256 */ 256 */
257void debugserver_encode_string(const char* buffer, char** encoded_buffer, uint32_t* encoded_length); 257LIBIMOBILEDEVICE_API void debugserver_encode_string(const char* buffer, char** encoded_buffer, uint32_t* encoded_length);
258 258
259/** 259/**
260 * Decodes a hex encoded string. 260 * Decodes a hex encoded string.
@@ -263,7 +263,7 @@ void debugserver_encode_string(const char* buffer, char** encoded_buffer, uint32
263 * @param encoded_length Length of the encoded buffer 263 * @param encoded_length Length of the encoded buffer
264 * @param buffer Decoded string to be freed by the caller 264 * @param buffer Decoded string to be freed by the caller
265 */ 265 */
266void debugserver_decode_string(const char *encoded_buffer, size_t encoded_length, char** buffer); 266LIBIMOBILEDEVICE_API void debugserver_decode_string(const char *encoded_buffer, size_t encoded_length, char** buffer);
267 267
268#ifdef __cplusplus 268#ifdef __cplusplus
269} 269}