From 2342dc5b4ef148b993fbe3816f3facdef8365546 Mon Sep 17 00:00:00 2001 From: Aaron Burghardt Date: Thu, 27 Mar 2014 10:07:09 -0400 Subject: Moved Doxygen comments from source files to public headers. Conflicts: include/libimobiledevice/afc.h --- src/service.c | 97 ----------------------------------------------------------- 1 file changed, 97 deletions(-) (limited to 'src/service.c') diff --git a/src/service.c b/src/service.c index e8444b8..701c8b4 100644 --- a/src/service.c +++ b/src/service.c @@ -52,18 +52,6 @@ static service_error_t idevice_to_service_error(idevice_error_t err) return SERVICE_E_UNKNOWN_ERROR; } -/** - * Creates a new service for the specified service descriptor. - * - * @param device The device to connect to. - * @param service The service descriptor returned by lockdownd_start_service. - * @param client Pointer that will be set to a newly allocated - * service_client_t upon successful return. - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG when one of the arguments is invalid, - * or SERVICE_E_MUX_ERROR when connecting to the device failed. - */ service_error_t service_client_new(idevice_t device, lockdownd_service_descriptor_t service, service_client_t *client) { if (!device || !service || service->port == 0 || !client || *client) @@ -88,21 +76,6 @@ service_error_t service_client_new(idevice_t device, lockdownd_service_descripto return SERVICE_E_SUCCESS; } -/** - * Starts a new service on the specified device with given name and - * connects to it. - * - * @param device The device to connect to. - * @param service_name The name of the service to start. - * @param client Pointer that will point to a newly allocated service_client_t - * upon successful return. Must be freed using service_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 SERVICE_E_SUCCESS on success, or a SERVICE_E_* error code - * otherwise. - */ service_error_t service_client_factory_start_service(idevice_t device, const char* service_name, void **client, const char* label, int16_t (*constructor_func)(idevice_t, lockdownd_service_descriptor_t, void**), int16_t *error_code) { *client = NULL; @@ -142,15 +115,6 @@ service_error_t service_client_factory_start_service(idevice_t device, const cha return (ec == SERVICE_E_SUCCESS) ? SERVICE_E_SUCCESS : SERVICE_E_START_SERVICE_ERROR; } -/** - * Frees a service instance. - * - * @param client The service instance to free. - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG when client is invalid, or a - * SERVICE_E_UNKNOWN_ERROR when another error occured. - */ service_error_t service_client_free(service_client_t client) { if (!client) @@ -164,19 +128,6 @@ service_error_t service_client_free(service_client_t client) return err; } -/** - * Sends data using the given service client. - * - * @param client The service client to use for sending. - * @param data Data to send - * @param size Size of the data to send - * @param sent Number of bytes sent (can be NULL to ignore) - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG when one or more parameters are - * invalid, or SERVICE_E_UNKNOWN_ERROR when an unspecified - * error occurs. - */ service_error_t service_send(service_client_t client, const char* data, uint32_t size, uint32_t *sent) { service_error_t res = SERVICE_E_UNKNOWN_ERROR; @@ -198,21 +149,6 @@ service_error_t service_send(service_client_t client, const char* data, uint32_t return res; } -/** - * Receives data using the given service client with specified timeout. - * - * @param client The service client to use for receiving - * @param data Buffer that will be filled with the data received - * @param size Number of bytes to receive - * @param received Number of bytes received (can be NULL to ignore) - * @param timeout Maximum time in milliseconds to wait for data. - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG when one or more parameters are - * invalid, SERVICE_E_MUX_ERROR when a communication error - * occurs, or SERVICE_E_UNKNOWN_ERROR when an unspecified - * error occurs. - */ service_error_t service_receive_with_timeout(service_client_t client, char* data, uint32_t size, uint32_t *received, unsigned int timeout) { service_error_t res = SERVICE_E_UNKNOWN_ERROR; @@ -233,35 +169,11 @@ service_error_t service_receive_with_timeout(service_client_t client, char* data return res; } -/** - * Receives data using the given service client. - * - * @param client The service client to use for receiving - * @param data Buffer that will be filled with the data received - * @param size Number of bytes to receive - * @param received Number of bytes received (can be NULL to ignore) - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG when one or more parameters are - * invalid, SERVICE_E_MUX_ERROR when a communication error - * occurs, or SERVICE_E_UNKNOWN_ERROR when an unspecified - * error occurs. - */ service_error_t service_receive(service_client_t client, char* data, uint32_t size, uint32_t *received) { return service_receive_with_timeout(client, data, size, received, 10000); } -/** - * Enable SSL for the given service client. - * - * @param client The connected service client for that SSL should be enabled. - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG if client or client->connection is - * NULL, SERVICE_E_SSL_ERROR when SSL could not be enabled, - * or SERVICE_E_UNKNOWN_ERROR otherwise. - */ service_error_t service_enable_ssl(service_client_t client) { if (!client || !client->connection) @@ -269,15 +181,6 @@ service_error_t service_enable_ssl(service_client_t client) return idevice_to_service_error(idevice_connection_enable_ssl(client->connection)); } -/** - * Disable SSL for the given service client. - * - * @param client The connected service client for that SSL should be disabled. - * - * @return SERVICE_E_SUCCESS on success, - * SERVICE_E_INVALID_ARG if client or client->connection is - * NULL, or SERVICE_E_UNKNOWN_ERROR otherwise. - */ service_error_t service_disable_ssl(service_client_t client) { if (!client || !client->connection) -- cgit v1.1-32-gdbae