diff options
Diffstat (limited to 'libusbmuxd/usbmuxd.h')
| -rw-r--r-- | libusbmuxd/usbmuxd.h | 181 |
1 files changed, 0 insertions, 181 deletions
diff --git a/libusbmuxd/usbmuxd.h b/libusbmuxd/usbmuxd.h deleted file mode 100644 index eabd216..0000000 --- a/libusbmuxd/usbmuxd.h +++ /dev/null | |||
| @@ -1,181 +0,0 @@ | |||
| 1 | /* | ||
| 2 | libusbmuxd - client library to talk to usbmuxd | ||
| 3 | |||
| 4 | Copyright (C) 2009 Nikias Bassen <nikias@gmx.li> | ||
| 5 | Copyright (C) 2009 Paul Sladen <libiphone@paul.sladen.org> | ||
| 6 | Copyright (C) 2009 Martin Szulecki <opensuse@sukimashita.com> | ||
| 7 | |||
| 8 | This library is free software; you can redistribute it and/or modify | ||
| 9 | it under the terms of the GNU Lesser General Public License as | ||
| 10 | published by the Free Software Foundation, either version 2.1 of the | ||
| 11 | License, or (at your option) any later version. | ||
| 12 | |||
| 13 | This library is distributed in the hope that it will be useful, | ||
| 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 16 | GNU General Public License for more details. | ||
| 17 | |||
| 18 | You should have received a copy of the GNU Lesser General Public | ||
| 19 | License along with this program; if not, write to the Free Software | ||
| 20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | ||
| 21 | |||
| 22 | */ | ||
| 23 | |||
| 24 | #ifndef __USBMUXD_H | ||
| 25 | #define __USBMUXD_H | ||
| 26 | #include <stdint.h> | ||
| 27 | |||
| 28 | #ifdef __cplusplus | ||
| 29 | extern "C" { | ||
| 30 | #endif | ||
| 31 | |||
| 32 | /** | ||
| 33 | * Device information structure holding data to identify the device. | ||
| 34 | * The relevant 'handle' should be passed to 'usbmuxd_connect()', to | ||
| 35 | * start a proxy connection. The value 'handle' should be considered | ||
| 36 | * opaque and no presumption made about the meaning of its value. | ||
| 37 | */ | ||
| 38 | typedef struct { | ||
| 39 | int handle; | ||
| 40 | int product_id; | ||
| 41 | char uuid[41]; | ||
| 42 | } usbmuxd_device_info_t; | ||
| 43 | |||
| 44 | /** | ||
| 45 | * event types for event callback function | ||
| 46 | */ | ||
| 47 | enum usbmuxd_event_type { | ||
| 48 | UE_DEVICE_ADD = 1, | ||
| 49 | UE_DEVICE_REMOVE | ||
| 50 | }; | ||
| 51 | |||
| 52 | /** | ||
| 53 | * Event structure that will be passed to the callback function. | ||
| 54 | * 'event' will contains the type of the event, and 'device' will contains | ||
| 55 | * information about the device. | ||
| 56 | */ | ||
| 57 | typedef struct { | ||
| 58 | int event; | ||
| 59 | usbmuxd_device_info_t device; | ||
| 60 | } usbmuxd_event_t; | ||
| 61 | |||
| 62 | /** | ||
| 63 | * Callback function prototype. | ||
| 64 | */ | ||
| 65 | typedef void (*usbmuxd_event_cb_t) (const usbmuxd_event_t *event, void *user_data); | ||
| 66 | |||
| 67 | /** | ||
| 68 | * Subscribe a callback function so that applications get to know about | ||
| 69 | * device add/remove events. | ||
| 70 | * | ||
| 71 | * @param callback A callback function that is executed when an event occurs. | ||
| 72 | * | ||
| 73 | * @return 0 on success or negative on error. | ||
| 74 | */ | ||
| 75 | int usbmuxd_subscribe(usbmuxd_event_cb_t callback, void *user_data); | ||
| 76 | |||
| 77 | /** | ||
| 78 | * Unsubscribe callback. | ||
| 79 | * | ||
| 80 | * @return only 0 for now. | ||
| 81 | */ | ||
| 82 | int usbmuxd_unsubscribe(); | ||
| 83 | |||
| 84 | /** | ||
| 85 | * Contacts usbmuxd and retrieves a list of connected devices. | ||
| 86 | * | ||
| 87 | * @param device_list A pointer to an array of usbmuxd_device_info_t | ||
| 88 | * that will hold records of the connected devices. The last record | ||
| 89 | * is a null-terminated record with all fields set to 0/NULL. | ||
| 90 | * @note The user has to free the list returned. | ||
| 91 | * | ||
| 92 | * @return number of attached devices, zero on no devices, or negative | ||
| 93 | * if an error occured. | ||
| 94 | */ | ||
| 95 | int usbmuxd_get_device_list(usbmuxd_device_info_t **device_list); | ||
| 96 | |||
| 97 | /** | ||
| 98 | * Frees the device list returned by an usbmuxd_get_device_list call | ||
| 99 | * | ||
| 100 | * @param device_list A pointer to an array of usbmuxd_device_info_t to free. | ||
| 101 | * | ||
| 102 | * @return 0 on success, -1 on error. | ||
| 103 | */ | ||
| 104 | int usbmuxd_device_list_free(usbmuxd_device_info_t **device_list); | ||
| 105 | |||
| 106 | /** | ||
| 107 | * Gets device information for the device specified by uuid. | ||
| 108 | * | ||
| 109 | * @param uuid A device uuid of the device to look for. If uuid is NULL, | ||
| 110 | * This function will return the first device found. | ||
| 111 | * @param device Pointer to a previously allocated (or static) | ||
| 112 | * usbmuxd_device_info_t that will be filled with the device info. | ||
| 113 | * | ||
| 114 | * @return 0 if no matching device is connected, 1 if the device was found, | ||
| 115 | * or a negative value on error. | ||
| 116 | */ | ||
| 117 | int usbmuxd_get_device_by_uuid(const char *uuid, usbmuxd_device_info_t *device); | ||
| 118 | |||
| 119 | /** | ||
| 120 | * Request proxy connect to | ||
| 121 | * | ||
| 122 | * @param handle returned by 'usbmuxd_scan()' | ||
| 123 | * | ||
| 124 | * @param tcp_port TCP port number on device, in range 0-65535. | ||
| 125 | * common values are 62078 for lockdown, and 22 for SSH. | ||
| 126 | * | ||
| 127 | * @return file descriptor socket of the connection, or -1 on error | ||
| 128 | */ | ||
| 129 | int usbmuxd_connect(const int handle, const unsigned short tcp_port); | ||
| 130 | |||
| 131 | /** | ||
| 132 | * Disconnect. For now, this just closes the socket file descriptor. | ||
| 133 | * | ||
| 134 | * @param sfd socker file descriptor returned by usbmuxd_connect() | ||
| 135 | * | ||
| 136 | * @return 0 on success, -1 on error. | ||
| 137 | */ | ||
| 138 | int usbmuxd_disconnect(int sfd); | ||
| 139 | |||
| 140 | /** | ||
| 141 | * Send data to the specified socket. | ||
| 142 | * | ||
| 143 | * @param sfd socket file descriptor returned by usbmuxd_connect() | ||
| 144 | * @param data buffer to send | ||
| 145 | * @param len size of buffer to send | ||
| 146 | * @param sent_bytes how many bytes sent | ||
| 147 | * | ||
| 148 | * @return 0 on success, a negative errno value otherwise. | ||
| 149 | */ | ||
| 150 | int usbmuxd_send(int sfd, const char *data, uint32_t len, uint32_t *sent_bytes); | ||
| 151 | |||
| 152 | /** | ||
| 153 | * Receive data from the specified socket. | ||
| 154 | * | ||
| 155 | * @param sfd socket file descriptor returned by usbmuxd_connect() | ||
| 156 | * @param data buffer to put the data to | ||
| 157 | * @param len number of bytes to receive | ||
| 158 | * @param recv_bytes number of bytes received | ||
| 159 | * @param timeout how many milliseconds to wait for data | ||
| 160 | * | ||
| 161 | * @return 0 on success, a negative errno value otherwise. | ||
| 162 | */ | ||
| 163 | int usbmuxd_recv_timeout(int sfd, char *data, uint32_t len, uint32_t *recv_bytes, unsigned int timeout); | ||
| 164 | |||
| 165 | /** | ||
| 166 | * Receive data from the specified socket with a default timeout. | ||
| 167 | * | ||
| 168 | * @param sfd socket file descriptor returned by usbmuxd_connect() | ||
| 169 | * @param data buffer to put the data to | ||
| 170 | * @param len number of bytes to receive | ||
| 171 | * @param recv_bytes number of bytes received | ||
| 172 | * | ||
| 173 | * @return 0 on success, a negative errno value otherwise. | ||
| 174 | */ | ||
| 175 | int usbmuxd_recv(int sfd, char *data, uint32_t len, uint32_t *recv_bytes); | ||
| 176 | |||
| 177 | #ifdef __cplusplus | ||
| 178 | } | ||
| 179 | #endif | ||
| 180 | |||
| 181 | #endif /* __USBMUXD_H */ | ||
