Synchronize data classes with a device and computer. More...
Data Structures | |
struct | mobilesync_anchors |
Typedefs | |
typedef int16_t | mobilesync_error_t |
Represents an error code. | |
typedef mobilesync_client_private * | mobilesync_client_t |
The client handle. | |
typedef mobilesync_anchors * | mobilesync_anchors_t |
Anchors used by the device and computer. | |
Enumerations | |
enum | mobilesync_sync_type_t { MOBILESYNC_SYNC_TYPE_FAST, MOBILESYNC_SYNC_TYPE_SLOW, MOBILESYNC_SYNC_TYPE_RESET } |
The sync type of the current sync session. More... | |
Functions | |
mobilesync_error_t | mobilesync_client_new (idevice_t device, uint16_t port, mobilesync_client_t *client) |
Connects to the mobilesync service on the specified device. | |
mobilesync_error_t | mobilesync_client_free (mobilesync_client_t client) |
Disconnects a mobilesync client from the device and frees up the mobilesync client data. | |
mobilesync_error_t | mobilesync_receive (mobilesync_client_t client, plist_t *plist) |
Polls the device for mobilesync data. | |
mobilesync_error_t | mobilesync_send (mobilesync_client_t client, plist_t plist) |
Sends mobilesync data to the device. | |
mobilesync_error_t | mobilesync_start (mobilesync_client_t client, const char *data_class, mobilesync_anchors_t anchors, uint64_t computer_data_class_version, mobilesync_sync_type_t *sync_type, uint64_t *device_data_class_version) |
Requests starting synchronization of a data class with the device. | |
mobilesync_error_t | mobilesync_cancel (mobilesync_client_t client, const char *reason) |
Cancells a running synchronization session with a device at any time. | |
mobilesync_error_t | mobilesync_finish (mobilesync_client_t client) |
Finish a synchronization session of a data class on the device. | |
mobilesync_error_t | mobilesync_get_all_records_from_device (mobilesync_client_t client) |
Requests to receive all records of the currently set data class from the device. | |
mobilesync_error_t | mobilesync_get_changes_from_device (mobilesync_client_t client) |
Requests to receive only changed records of the currently set data class from the device. | |
mobilesync_error_t | mobilesync_receive_changes (mobilesync_client_t client, plist_t *entities, uint8_t *is_last_record, plist_t *actions) |
Receives changed entitites of the currently set data class from the device. | |
mobilesync_error_t | mobilesync_acknowledge_changes_from_device (mobilesync_client_t client) |
Acknowledges to the device that the changes have been merged on the computer. | |
mobilesync_error_t | mobilesync_ready_to_send_changes_from_computer (mobilesync_client_t client) |
Verifies if the device is ready to receive changes from the computer. | |
mobilesync_error_t | mobilesync_send_changes (mobilesync_client_t client, plist_t entities, uint8_t is_last_record, plist_t actions) |
Sends changed entitites of the currently set data class to the device. | |
mobilesync_error_t | mobilesync_remap_identifiers (mobilesync_client_t client, plist_t *mapping) |
Receives any remapped identifiers reported after the device merged submitted changes. | |
mobilesync_anchors_t | mobilesync_anchors_new (const char *device_anchor, const char *computer_anchor) |
Allocates memory for a new anchors struct initialized with the passed anchors. | |
void | mobilesync_anchors_free (mobilesync_anchors_t anchors) |
Free memory used by anchors. | |
plist_t | mobilesync_actions_new () |
Create a new actions plist to use in mobilesync_send_changes(). | |
void | mobilesync_actions_add (plist_t actions,...) G_GNUC_NULL_TERMINATED |
Add one or more new key:value pairs to the given actions plist. | |
void | mobilesync_actions_free (plist_t actions) |
Free actions plist. | |
Error Codes | |
| |
#define | MOBILESYNC_E_SUCCESS 0 |
#define | MOBILESYNC_E_INVALID_ARG -1 |
#define | MOBILESYNC_E_PLIST_ERROR -2 |
#define | MOBILESYNC_E_MUX_ERROR -3 |
#define | MOBILESYNC_E_BAD_VERSION -4 |
#define | MOBILESYNC_E_SYNC_REFUSED -5 |
#define | MOBILESYNC_E_CANCELLED -6 |
#define | MOBILESYNC_E_WRONG_DIRECTION -7 |
#define | MOBILESYNC_E_NOT_READY -8 |
#define | MOBILESYNC_E_UNKNOWN_ERROR -256 |
Synchronize data classes with a device and computer.
typedef mobilesync_anchors* mobilesync_anchors_t |
Anchors used by the device and computer.
typedef int16_t mobilesync_error_t |
Represents an error code.
The sync type of the current sync session.
mobilesync_error_t mobilesync_acknowledge_changes_from_device | ( | mobilesync_client_t | client | ) |
Acknowledges to the device that the changes have been merged on the computer.
client | The mobilesync client |
void mobilesync_actions_add | ( | plist_t | actions, | |
... | ||||
) |
Add one or more new key:value pairs to the given actions plist.
actions | The actions to modify.
|
void mobilesync_actions_free | ( | plist_t | actions | ) |
Free actions plist.
actions | The actions plist to free. Does nothing if NULL is passed. |
plist_t mobilesync_actions_new | ( | ) |
Create a new actions plist to use in mobilesync_send_changes().
void mobilesync_anchors_free | ( | mobilesync_anchors_t | anchors | ) |
Free memory used by anchors.
anchors | The anchors free. |
mobilesync_anchors_t mobilesync_anchors_new | ( | const char * | device_anchor, | |
const char * | computer_anchor | |||
) |
Allocates memory for a new anchors struct initialized with the passed anchors.
device_anchor | An anchor the device reported the last time or NULL if none is known yet which for instance is true on first synchronization.
|
mobilesync_error_t mobilesync_cancel | ( | mobilesync_client_t | client, | |
const char * | reason | |||
) |
Cancells a running synchronization session with a device at any time.
client | The mobilesync client
|
mobilesync_error_t mobilesync_client_free | ( | mobilesync_client_t | client | ) |
Disconnects a mobilesync client from the device and frees up the mobilesync client data.
client | The mobilesync client to disconnect and free. |
mobilesync_error_t mobilesync_client_new | ( | idevice_t | device, | |
uint16_t | port, | |||
mobilesync_client_t * | client | |||
) |
Connects to the mobilesync service on the specified device.
device | The device to connect to.
|
mobilesync_error_t mobilesync_finish | ( | mobilesync_client_t | client | ) |
Finish a synchronization session of a data class on the device.
A session must have previously been started using mobilesync_start().
client | The mobilesync client |
mobilesync_error_t mobilesync_get_all_records_from_device | ( | mobilesync_client_t | client | ) |
Requests to receive all records of the currently set data class from the device.
The actually changes are retrieved using mobilesync_receive_changes() after this request has been successful.
client | The mobilesync client |
mobilesync_error_t mobilesync_get_changes_from_device | ( | mobilesync_client_t | client | ) |
Requests to receive only changed records of the currently set data class from the device.
The actually changes are retrieved using mobilesync_receive_changes() after this request has been successful.
client | The mobilesync client |
mobilesync_error_t mobilesync_ready_to_send_changes_from_computer | ( | mobilesync_client_t | client | ) |
Verifies if the device is ready to receive changes from the computer.
This call changes the synchronization direction so that mobilesync_send_changes() can be used to send changes to the device.
client | The mobilesync client |
mobilesync_error_t mobilesync_receive | ( | mobilesync_client_t | client, | |
plist_t * | plist | |||
) |
Polls the device for mobilesync data.
client | The mobilesync client
|
mobilesync_error_t mobilesync_receive_changes | ( | mobilesync_client_t | client, | |
plist_t * | entities, | |||
uint8_t * | is_last_record, | |||
plist_t * | actions | |||
) |
Receives changed entitites of the currently set data class from the device.
client | The mobilesync client
|
mobilesync_error_t mobilesync_remap_identifiers | ( | mobilesync_client_t | client, | |
plist_t * | mapping | |||
) |
Receives any remapped identifiers reported after the device merged submitted changes.
client | The mobilesync client
|
mobilesync_error_t mobilesync_send | ( | mobilesync_client_t | client, | |
plist_t | plist | |||
) |
Sends mobilesync data to the device.
client | The mobilesync client
|
mobilesync_error_t mobilesync_send_changes | ( | mobilesync_client_t | client, | |
plist_t | entities, | |||
uint8_t | is_last_record, | |||
plist_t | actions | |||
) |
Sends changed entitites of the currently set data class to the device.
client | The mobilesync client
|
mobilesync_error_t mobilesync_start | ( | mobilesync_client_t | client, | |
const char * | data_class, | |||
mobilesync_anchors_t | anchors, | |||
uint64_t | computer_data_class_version, | |||
mobilesync_sync_type_t * | sync_type, | |||
uint64_t * | device_data_class_version | |||
) |
Requests starting synchronization of a data class with the device.
client | The mobilesync client
|
References MOBILESYNC_SYNC_TYPE_FAST, MOBILESYNC_SYNC_TYPE_RESET, and MOBILESYNC_SYNC_TYPE_SLOW.