libimobiledevice
1.2.0
|
Retrieve compressed CPIO archives. More...
Macros | |
#define | FILE_RELAY_SERVICE_NAME "com.apple.mobile.file_relay" |
Typedefs | |
typedef struct file_relay_client_private | file_relay_client_private |
typedef file_relay_client_private * | file_relay_client_t |
The client handle. More... | |
Enumerations | |
enum | file_relay_error_t { FILE_RELAY_E_SUCCESS = 0, FILE_RELAY_E_INVALID_ARG = -1, FILE_RELAY_E_PLIST_ERROR = -2, FILE_RELAY_E_MUX_ERROR = -3, FILE_RELAY_E_INVALID_SOURCE = -4, FILE_RELAY_E_STAGING_EMPTY = -5, FILE_RELAY_E_PERMISSION_DENIED = -6, FILE_RELAY_E_UNKNOWN_ERROR = -256 } |
Error Codes. | |
Functions | |
file_relay_error_t | file_relay_client_new (idevice_t device, lockdownd_service_descriptor_t service, file_relay_client_t *client) |
Connects to the file_relay service on the specified device. More... | |
file_relay_error_t | file_relay_client_start_service (idevice_t device, file_relay_client_t *client, const char *label) |
Starts a new file_relay service on the specified device and connects to it. More... | |
file_relay_error_t | file_relay_client_free (file_relay_client_t client) |
Disconnects a file_relay client from the device and frees up the file_relay client data. More... | |
file_relay_error_t | file_relay_request_sources (file_relay_client_t client, const char **sources, idevice_connection_t *connection) |
Request data for the given sources. More... | |
file_relay_error_t | file_relay_request_sources_timeout (file_relay_client_t client, const char **sources, idevice_connection_t *connection, unsigned int timeout) |
Request data for the given sources. More... | |
Retrieve compressed CPIO archives.
typedef file_relay_client_private* file_relay_client_t |
The client handle.
file_relay_error_t file_relay_client_free | ( | file_relay_client_t | client | ) |
Disconnects a file_relay client from the device and frees up the file_relay client data.
client | The file_relay client to disconnect and free. |
file_relay_error_t file_relay_client_new | ( | idevice_t | device, |
lockdownd_service_descriptor_t | service, | ||
file_relay_client_t * | client | ||
) |
Connects to the file_relay service on the specified device.
device | The device to connect to. |
service | The service descriptor returned by lockdownd_start_service. |
client | Reference that will point to a newly allocated file_relay_client_t upon successful return. |
file_relay_error_t file_relay_client_start_service | ( | idevice_t | device, |
file_relay_client_t * | client, | ||
const char * | label | ||
) |
Starts a new file_relay service on the specified device and connects to it.
device | The device to connect to. |
client | Pointer that will point to a newly allocated file_relay_client_t upon successful return. Must be freed using file_relay_client_free() after use. |
label | The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd. |
file_relay_error_t file_relay_request_sources | ( | file_relay_client_t | client, |
const char ** | sources, | ||
idevice_connection_t * | connection | ||
) |
Request data for the given sources.
client | The connected file_relay client. |
sources | A NULL-terminated list of sources to retrieve. Valid sources are:
|
connection | The connection that has to be used for receiving the data using idevice_connection_receive(). The connection will be closed automatically by the device, but use file_relay_client_free() to clean up properly. |
timeout | Maximum time in milliseconds to wait for data. |
file_relay_error_t file_relay_request_sources_timeout | ( | file_relay_client_t | client, |
const char ** | sources, | ||
idevice_connection_t * | connection, | ||
unsigned int | timeout | ||
) |
Request data for the given sources.
Calls file_relay_request_sources_timeout() with a timeout of 60000 milliseconds (60 seconds).
client | The connected file_relay client. |
sources | A NULL-terminated list of sources to retrieve. Valid sources are:
|
connection | The connection that has to be used for receiving the data using idevice_connection_receive(). The connection will be closed automatically by the device, but use file_relay_client_free() to clean up properly. |