diff options
| author | 2010-03-05 16:27:34 +0100 | |
|---|---|---|
| committer | 2010-03-08 21:08:07 -0800 | |
| commit | 894035083555368bc056d3ba276ebbe2312ecdab (patch) | |
| tree | cd5e544afe6cef41b8b31f8b9b304676c2b5ca02 /src/installation_proxy.c | |
| parent | 77aa0b3c5b4fc6cff147e98a2130dd11204b40ad (diff) | |
| download | libimobiledevice-894035083555368bc056d3ba276ebbe2312ecdab.tar.gz libimobiledevice-894035083555368bc056d3ba276ebbe2312ecdab.tar.bz2 | |
installation_proxy: docs updated
Diffstat (limited to 'src/installation_proxy.c')
| -rw-r--r-- | src/installation_proxy.c | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/src/installation_proxy.c b/src/installation_proxy.c index 3a6d22a..9fb5109 100644 --- a/src/installation_proxy.c +++ b/src/installation_proxy.c | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | /* | 1 | /* |
| 2 | * installation_proxy.c | 2 | * installation_proxy.c |
| 3 | * Installation Proxy implementation. | 3 | * com.apple.mobile.installation_proxy service implementation. |
| 4 | * | 4 | * |
| 5 | * Copyright (c) 2009 Nikias Bassen, All Rights Reserved. | 5 | * Copyright (c) 2009 Nikias Bassen, All Rights Reserved. |
| 6 | * | 6 | * |
| @@ -35,7 +35,8 @@ struct instproxy_status_data { | |||
| 35 | char *operation; | 35 | char *operation; |
| 36 | }; | 36 | }; |
| 37 | 37 | ||
| 38 | /** Locks an installation_proxy client, done for thread safety stuff. | 38 | /** |
| 39 | * Locks an installation_proxy client, used for thread safety. | ||
| 39 | * | 40 | * |
| 40 | * @param client The installation_proxy client to lock | 41 | * @param client The installation_proxy client to lock |
| 41 | */ | 42 | */ |
| @@ -45,7 +46,8 @@ static void instproxy_lock(instproxy_client_t client) | |||
| 45 | g_mutex_lock(client->mutex); | 46 | g_mutex_lock(client->mutex); |
| 46 | } | 47 | } |
| 47 | 48 | ||
| 48 | /** Unlocks an installation_proxy client, done for thread safety stuff. | 49 | /** |
| 50 | * Unlocks an installation_proxy client, used for thread safety. | ||
| 49 | * | 51 | * |
| 50 | * @param client The installation_proxy client to lock | 52 | * @param client The installation_proxy client to lock |
| 51 | */ | 53 | */ |
| @@ -82,7 +84,7 @@ static instproxy_error_t instproxy_error(property_list_service_error_t err) | |||
| 82 | } | 84 | } |
| 83 | 85 | ||
| 84 | /** | 86 | /** |
| 85 | * Creates a new installation_proxy client | 87 | * Connects to the installation_proxy service on the specified device. |
| 86 | * | 88 | * |
| 87 | * @param device The device to connect to | 89 | * @param device The device to connect to |
| 88 | * @param port Destination port (usually given by lockdownd_start_service). | 90 | * @param port Destination port (usually given by lockdownd_start_service). |
| @@ -116,9 +118,10 @@ instproxy_error_t instproxy_client_new(idevice_t device, uint16_t port, instprox | |||
| 116 | } | 118 | } |
| 117 | 119 | ||
| 118 | /** | 120 | /** |
| 119 | * Frees an installation_proxy client. | 121 | * Disconnects an installation_proxy client from the device and frees up the |
| 122 | * installation_proxy client data. | ||
| 120 | * | 123 | * |
| 121 | * @param client The installation_proxy client to free. | 124 | * @param client The installation_proxy client to disconnect and free. |
| 122 | * | 125 | * |
| 123 | * @return INSTPROXY_E_SUCCESS on success | 126 | * @return INSTPROXY_E_SUCCESS on success |
| 124 | * or INSTPROXY_E_INVALID_ARG if client is NULL. | 127 | * or INSTPROXY_E_INVALID_ARG if client is NULL. |
| @@ -144,7 +147,7 @@ instproxy_error_t instproxy_client_free(instproxy_client_t client) | |||
| 144 | 147 | ||
| 145 | /** | 148 | /** |
| 146 | * Send a command with specified options to the device. | 149 | * Send a command with specified options to the device. |
| 147 | * Internally used only. | 150 | * Only used internally. |
| 148 | * | 151 | * |
| 149 | * @param client The connected installation_proxy client. | 152 | * @param client The connected installation_proxy client. |
| 150 | * @param command The command to execute. Required. | 153 | * @param command The command to execute. Required. |
