summaryrefslogtreecommitdiffstats
path: root/src/house_arrest.c
diff options
context:
space:
mode:
authorGravatar Aaron Burghardt2014-03-27 10:07:09 -0400
committerGravatar Aaron Burghardt2014-03-27 21:40:43 -0400
commit2342dc5b4ef148b993fbe3816f3facdef8365546 (patch)
tree69f812d91b2fc07db0fad5dcba6c80d2f8b6849e /src/house_arrest.c
parentee82e861a8c942b5013accd7589cf898d1f97167 (diff)
downloadlibimobiledevice-2342dc5b4ef148b993fbe3816f3facdef8365546.tar.gz
libimobiledevice-2342dc5b4ef148b993fbe3816f3facdef8365546.tar.bz2
Moved Doxygen comments from source files to public headers.
Conflicts: include/libimobiledevice/afc.h
Diffstat (limited to 'src/house_arrest.c')
-rw-r--r--src/house_arrest.c107
1 files changed, 0 insertions, 107 deletions
diff --git a/src/house_arrest.c b/src/house_arrest.c
index 9aaad34..4158368 100644
--- a/src/house_arrest.c
+++ b/src/house_arrest.c
@@ -55,17 +55,6 @@ static house_arrest_error_t house_arrest_error(property_list_service_error_t err
return HOUSE_ARREST_E_UNKNOWN_ERROR;
}
-/**
- * Connects to the house_arrest service on the specified device.
- *
- * @param device The device to connect to.
- * @param service The service descriptor returned by lockdownd_start_service.
- * @param client Pointer that will point to a newly allocated
- * housearrest_client_t upon successful return.
- *
- * @return HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when
- * client is NULL, or an HOUSE_ARREST_E_* error code otherwise.
- */
house_arrest_error_t house_arrest_client_new(idevice_t device, lockdownd_service_descriptor_t service, house_arrest_client_t *client)
{
property_list_service_client_t plistclient = NULL;
@@ -82,19 +71,6 @@ house_arrest_error_t house_arrest_client_new(idevice_t device, lockdownd_service
return HOUSE_ARREST_E_SUCCESS;
}
-/**
- * Starts a new house_arrest service on the specified device and connects to it.
- *
- * @param device The device to connect to.
- * @param client Pointer that will point to a newly allocated
- * house_arrest_client_t upon successful return. Must be freed using
- * house_arrest_client_free() after use.
- * @param label The label to use for communication. Usually the program name.
- * Pass NULL to disable sending the label in requests to lockdownd.
- *
- * @return HOUSE_ARREST_E_SUCCESS on success, or an HOUSE_ARREST_E_* error
- * code otherwise.
- */
house_arrest_error_t house_arrest_client_start_service(idevice_t device, house_arrest_client_t * client, const char* label)
{
house_arrest_error_t err = HOUSE_ARREST_E_UNKNOWN_ERROR;
@@ -102,20 +78,6 @@ house_arrest_error_t house_arrest_client_start_service(idevice_t device, house_a
return err;
}
-/**
- * Disconnects an house_arrest client from the device and frees up the
- * house_arrest client data.
- *
- * @note After using afc_client_new_from_house_arrest_client(), make sure
- * you call afc_client_free() before calling this function to ensure
- * a proper cleanup. Do not call this function if you still need to
- * perform AFC operations since it will close the connection.
- *
- * @param client The house_arrest client to disconnect and free.
- *
- * @return HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when
- * client is NULL, or an HOUSE_ARREST_E_* error code otherwise.
- */
house_arrest_error_t house_arrest_client_free(house_arrest_client_t client)
{
if (!client)
@@ -131,23 +93,6 @@ house_arrest_error_t house_arrest_client_free(house_arrest_client_t client)
return err;
}
-/**
- * Sends a generic request to the connected house_arrest service.
- *
- * @param client The house_arrest client to use.
- * @param dict The request to send as a plist of type PLIST_DICT.
- *
- * @note If this function returns HOUSE_ARREST_E_SUCCESS it does not mean
- * that the request was successful. To check for success or failure you
- * need to call house_arrest_get_result().
- * @see house_arrest_get_result
- *
- * @return HOUSE_ARREST_E_SUCCESS if the request was successfully sent,
- * HOUSE_ARREST_E_INVALID_ARG if client or dict is invalid,
- * HOUSE_ARREST_E_PLIST_ERROR if dict is not a plist of type PLIST_DICT,
- * HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode,
- * or HOUSE_ARREST_E_CONN_FAILED if a connection error occured.
- */
house_arrest_error_t house_arrest_send_request(house_arrest_client_t client, plist_t dict)
{
if (!client || !client->parent || !dict)
@@ -164,25 +109,6 @@ house_arrest_error_t house_arrest_send_request(house_arrest_client_t client, pli
return res;
}
-/**
- * Send a command to the connected house_arrest service.
- * Calls house_arrest_send_request() internally.
- *
- * @param client The house_arrest client to use.
- * @param command The command to send. Currently, only VendContainer and
- * VendDocuments are known.
- * @param appid The application identifier to pass along with the .
- *
- * @note If this function returns HOUSE_ARREST_E_SUCCESS it does not mean
- * that the command was successful. To check for success or failure you
- * need to call house_arrest_get_result().
- * @see house_arrest_get_result
- *
- * @return HOUSE_ARREST_E_SUCCESS if the command was successfully sent,
- * HOUSE_ARREST_E_INVALID_ARG if client, command, or appid is invalid,
- * HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode,
- * or HOUSE_ARREST_E_CONN_FAILED if a connection error occured.
- */
house_arrest_error_t house_arrest_send_command(house_arrest_client_t client, const char *command, const char *appid)
{
if (!client || !client->parent || !command || !appid)
@@ -203,20 +129,6 @@ house_arrest_error_t house_arrest_send_command(house_arrest_client_t client, con
return res;
}
-/**
- * Retrieves the result of a previously sent house_arrest_request_* request.
- *
- * @param client The house_arrest client to use
- * @param dict Pointer that will be set to a plist containing the result to
- * the last performed operation. It holds a key 'Status' with the value
- * 'Complete' on success or a key 'Error' with an error description as
- * value. The caller is responsible for freeing the returned plist.
- *
- * @return HOUSE_ARREST_E_SUCCESS if a result plist was retrieved,
- * HOUSE_ARREST_E_INVALID_ARG if client is invalid,
- * HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode,
- * or HOUSE_ARREST_E_CONN_FAILED if a connection error occured.
- */
house_arrest_error_t house_arrest_get_result(house_arrest_client_t client, plist_t *dict)
{
if (!client || !client->parent)
@@ -235,25 +147,6 @@ house_arrest_error_t house_arrest_get_result(house_arrest_client_t client, plist
return res;
}
-/**
- * Creates an AFC client using the given house_arrest client's connection
- * allowing file access to a specific application directory requested by
- * functions like house_arrest_request_vendor_documents().
- *
- * @param client The house_arrest client to use.
- * @param afc_client Pointer that will be set to a newly allocated afc_client_t
- * upon successful return.
- *
- * @note After calling this function the house_arrest client will go in an
- * AFC mode that will only allow calling house_arrest_client_free().
- * Only call house_arrest_client_free() if all AFC operations have
- * completed since it will close the connection.
- *
- * @return AFC_E_SUCCESS if the afc client was successfully created,
- * AFC_E_INVALID_ARG if client is invalid or was already used to create
- * an afc client, or an AFC_E_* error code returned by
- * afc_client_new_with_service_client().
- */
afc_error_t afc_client_new_from_house_arrest_client(house_arrest_client_t client, afc_client_t *afc_client)
{
if (!client || !client->parent || (client->mode == HOUSE_ARREST_CLIENT_MODE_AFC)) {