summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/libimobiledevice/bt_packet_logger.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/include/libimobiledevice/bt_packet_logger.h b/include/libimobiledevice/bt_packet_logger.h
index 8916219..230040a 100644
--- a/include/libimobiledevice/bt_packet_logger.h
+++ b/include/libimobiledevice/bt_packet_logger.h
@@ -53,7 +53,7 @@ typedef struct {
53typedef struct bt_packet_logger_client_private bt_packet_logger_client_private; 53typedef struct bt_packet_logger_client_private bt_packet_logger_client_private;
54typedef bt_packet_logger_client_private *bt_packet_logger_client_t; /**< The client handle. */ 54typedef bt_packet_logger_client_private *bt_packet_logger_client_t; /**< The client handle. */
55 55
56/** Receives each character received from the device. */ 56/** Receives each hci packet received from the device. */
57typedef void (*bt_packet_logger_receive_cb_t)(uint8_t * data, uint16_t len, void *user_data); 57typedef void (*bt_packet_logger_receive_cb_t)(uint8_t * data, uint16_t len, void *user_data);
58 58
59/* Interface */ 59/* Interface */
@@ -100,32 +100,32 @@ bt_packet_logger_error_t bt_packet_logger_client_free(bt_packet_logger_client_t
100 100
101 101
102/** 102/**
103 * Starts capturing the syslog of the device using a callback. 103 * Starts capturing the hci interface from the device using a callback.
104 * 104 *
105 * Use bt_packet_logger_stop_capture() to stop receiving the syslog. 105 * Use bt_packet_logger_stop_capture() to stop receiving hci data.
106 * 106 *
107 * @param client The bt_packet_logger client to use 107 * @param client The bt_packet_logger client to use
108 * @param callback Callback to receive each character from the syslog. 108 * @param callback Callback to receive each packet from the hci interface.
109 * @param user_data Custom pointer passed to the callback function. 109 * @param user_data Custom pointer passed to the callback function.
110 * 110 *
111 * @return BT_PACKET_LOGGER_E_SUCCESS on success, 111 * @return BT_PACKET_LOGGER_E_SUCCESS on success,
112 * BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are 112 * BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are
113 * invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified 113 * invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified
114 * error occurs or a syslog capture has already been started. 114 * error occurs or an hci capture has already been started.
115 */ 115 */
116bt_packet_logger_error_t bt_packet_logger_start_capture(bt_packet_logger_client_t client, bt_packet_logger_receive_cb_t callback, void* user_data); 116bt_packet_logger_error_t bt_packet_logger_start_capture(bt_packet_logger_client_t client, bt_packet_logger_receive_cb_t callback, void* user_data);
117 117
118/** 118/**
119 * Stops capturing the syslog of the device. 119 * Stops capturing the hci interface from the device.
120 * 120 *
121 * Use bt_packet_logger_start_capture() to start receiving the syslog. 121 * Use bt_packet_logger_start_capture() to start receiving the hci data.
122 * 122 *
123 * @param client The bt_packet_logger client to use 123 * @param client The bt_packet_logger client to use
124 * 124 *
125 * @return BT_PACKET_LOGGER_E_SUCCESS on success, 125 * @return BT_PACKET_LOGGER_E_SUCCESS on success,
126 * BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are 126 * BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are
127 * invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified 127 * invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified
128 * error occurs or a syslog capture has already been started. 128 * error occurs or an hci capture has already been started.
129 */ 129 */
130bt_packet_logger_error_t bt_packet_logger_stop_capture(bt_packet_logger_client_t client); 130bt_packet_logger_error_t bt_packet_logger_stop_capture(bt_packet_logger_client_t client);
131 131