summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2010-05-25 11:41:28 +0200
committerGravatar Martin Szulecki2010-06-04 19:21:41 +0200
commit8c0ee866a53c6134d4e9b0803cba13e2469807d1 (patch)
tree23a215a74543dbef3c0eb488288371c1ad48a846
parent69229a3edffbbe328065f62e28e39cd08d64b8aa (diff)
downloadlibimobiledevice-8c0ee866a53c6134d4e9b0803cba13e2469807d1.tar.gz
libimobiledevice-8c0ee866a53c6134d4e9b0803cba13e2469807d1.tar.bz2
Document that lockdownd automatically drops the connection when idle
-rw-r--r--src/lockdown.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/lockdown.c b/src/lockdown.c
index bb6aa49..97df6da 100644
--- a/src/lockdown.c
+++ b/src/lockdown.c
@@ -597,6 +597,9 @@ lockdownd_error_t lockdownd_get_device_name(lockdownd_client_t client, char **de
*
* @note This function does not pair with the device or start a session. This
* has to be done manually by the caller after the client is created.
+ * The device disconnects automatically if the lockdown connection idles
+ * for more than 10 seconds. Make sure to call lockdownd_client_free() as soon
+ * as the connection is no longer needed.
*
* @param device The device to create a lockdownd client for
* @param client The pointer to the location of the new lockdownd_client
@@ -640,6 +643,10 @@ lockdownd_error_t lockdownd_client_new(idevice_t device, lockdownd_client_t *cli
* The handshake consists out of query_type, validate_pair, pair and
* start_session calls. It uses the internal pairing record management.
*
+ * @note The device disconnects automatically if the lockdown connection idles
+ * for more than 10 seconds. Make sure to call lockdownd_client_free() as soon
+ * as the connection is no longer needed.
+ *
* @param device The device to create a lockdownd client for
* @param client The pointer to the location of the new lockdownd_client
* @param label The label to use for communication. Usually the program name.