diff options
Diffstat (limited to 'include/libimobiledevice/reverse_proxy.h')
-rw-r--r-- | include/libimobiledevice/reverse_proxy.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/include/libimobiledevice/reverse_proxy.h b/include/libimobiledevice/reverse_proxy.h index 2539bd9..b7a93ff 100644 --- a/include/libimobiledevice/reverse_proxy.h +++ b/include/libimobiledevice/reverse_proxy.h | |||
@@ -2,6 +2,7 @@ | |||
2 | * @file libimobiledevice/reverse_proxy.h | 2 | * @file libimobiledevice/reverse_proxy.h |
3 | * @brief Provide a reverse proxy to allow the device to communicate through, | 3 | * @brief Provide a reverse proxy to allow the device to communicate through, |
4 | * which is used during firmware restore. | 4 | * which is used during firmware restore. |
5 | * \internal | ||
5 | * | 6 | * |
6 | * Copyright (c) 2021 Nikias Bassen, All Rights Reserved. | 7 | * Copyright (c) 2021 Nikias Bassen, All Rights Reserved. |
7 | * | 8 | * |
@@ -29,7 +30,7 @@ extern "C" { | |||
29 | 30 | ||
30 | #include <libimobiledevice/libimobiledevice.h> | 31 | #include <libimobiledevice/libimobiledevice.h> |
31 | 32 | ||
32 | #define REVERSE_PROXY_DEFAULT_PORT 1082 | 33 | #define REVERSE_PROXY_DEFAULT_PORT 1082 /**< default port the reverse proxy is listening on */ |
33 | 34 | ||
34 | /** Error Codes */ | 35 | /** Error Codes */ |
35 | typedef enum { | 36 | typedef enum { |
@@ -43,14 +44,16 @@ typedef enum { | |||
43 | REVERSE_PROXY_E_UNKNOWN_ERROR = -256 | 44 | REVERSE_PROXY_E_UNKNOWN_ERROR = -256 |
44 | } reverse_proxy_error_t; | 45 | } reverse_proxy_error_t; |
45 | 46 | ||
46 | typedef struct reverse_proxy_client_private reverse_proxy_client_private; | 47 | typedef struct reverse_proxy_client_private reverse_proxy_client_private; /**< \private */ |
47 | typedef reverse_proxy_client_private *reverse_proxy_client_t; /**< The client handle. */ | 48 | typedef reverse_proxy_client_private *reverse_proxy_client_t; /**< The client handle. */ |
48 | 49 | ||
50 | /** reverse proxy client type */ | ||
49 | typedef enum { | 51 | typedef enum { |
50 | RP_TYPE_CTRL = 1, /**< control connection */ | 52 | RP_TYPE_CTRL = 1, /**< control connection */ |
51 | RP_TYPE_CONN /**< proxy connection */ | 53 | RP_TYPE_CONN /**< proxy connection */ |
52 | } reverse_proxy_client_type_t; | 54 | } reverse_proxy_client_type_t; |
53 | 55 | ||
56 | /** reverse proxy status for reverse_proxy_status_cb_t callback */ | ||
54 | typedef enum { | 57 | typedef enum { |
55 | RP_STATUS_READY = 1, /**< proxy is ready */ | 58 | RP_STATUS_READY = 1, /**< proxy is ready */ |
56 | RP_STATUS_TERMINATE, /**< proxy terminated */ | 59 | RP_STATUS_TERMINATE, /**< proxy terminated */ |
@@ -60,6 +63,7 @@ typedef enum { | |||
60 | RP_STATUS_DISCONNECTED, /**< connection closed (only RP_TYPE_CONN) */ | 63 | RP_STATUS_DISCONNECTED, /**< connection closed (only RP_TYPE_CONN) */ |
61 | } reverse_proxy_status_t; | 64 | } reverse_proxy_status_t; |
62 | 65 | ||
66 | /** reverse proxy data direction passed to reverse_proxy_data_cb_t callback */ | ||
63 | typedef enum { | 67 | typedef enum { |
64 | RP_DATA_DIRECTION_OUT = 1, /**< data going out to remote host */ | 68 | RP_DATA_DIRECTION_OUT = 1, /**< data going out to remote host */ |
65 | RP_DATA_DIRECTION_IN /**< data coming in from remote host */ | 69 | RP_DATA_DIRECTION_IN /**< data coming in from remote host */ |