diff options
Diffstat (limited to 'include/libimobiledevice/syslog_relay.h')
| -rw-r--r-- | include/libimobiledevice/syslog_relay.h | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/include/libimobiledevice/syslog_relay.h b/include/libimobiledevice/syslog_relay.h index ea7b649..89d9489 100644 --- a/include/libimobiledevice/syslog_relay.h +++ b/include/libimobiledevice/syslog_relay.h | |||
| @@ -3,7 +3,8 @@ | |||
| 3 | * @brief Capture the syslog output from a device. | 3 | * @brief Capture the syslog output from a device. |
| 4 | * \internal | 4 | * \internal |
| 5 | * | 5 | * |
| 6 | * Copyright (c) 2013-2014 Martin Szulecki All Rights Reserved. | 6 | * Copyright (c) 2019-2020 Nikias Bassen, All Rights Reserved. |
| 7 | * Copyright (c) 2013-2014 Martin Szulecki, All Rights Reserved. | ||
| 7 | * | 8 | * |
| 8 | * This library is free software; you can redistribute it and/or | 9 | * This library is free software; you can redistribute it and/or |
| 9 | * modify it under the terms of the GNU Lesser General Public | 10 | * modify it under the terms of the GNU Lesser General Public |
| @@ -109,6 +110,27 @@ syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client); | |||
| 109 | syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data); | 110 | syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data); |
| 110 | 111 | ||
| 111 | /** | 112 | /** |
| 113 | * Starts capturing the *raw* syslog of the device using a callback. | ||
| 114 | * This function is like syslog_relay_start_capture with the difference that | ||
| 115 | * it will neither check nor process the received data before passing it to | ||
| 116 | * the callback function. | ||
| 117 | * | ||
| 118 | * Use syslog_relay_stop_capture() to stop receiving the syslog. | ||
| 119 | * | ||
| 120 | * @note Use syslog_relay_start_capture for a safer implementation. | ||
| 121 | * | ||
| 122 | * @param client The syslog_relay client to use | ||
| 123 | * @param callback Callback to receive each character from the syslog. | ||
| 124 | * @param user_data Custom pointer passed to the callback function. | ||
| 125 | * | ||
| 126 | * @return SYSLOG_RELAY_E_SUCCESS on success, | ||
| 127 | * SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are | ||
| 128 | * invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified | ||
| 129 | * error occurs or a syslog capture has already been started. | ||
| 130 | */ | ||
| 131 | syslog_relay_error_t syslog_relay_start_capture_raw(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data); | ||
| 132 | |||
| 133 | /** | ||
| 112 | * Stops capturing the syslog of the device. | 134 | * Stops capturing the syslog of the device. |
| 113 | * | 135 | * |
| 114 | * Use syslog_relay_start_capture() to start receiving the syslog. | 136 | * Use syslog_relay_start_capture() to start receiving the syslog. |
