Outline ![]()
Files ![]()
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/tcp_transport/include/esp_transport_socks_proxy.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
* SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <stdint.h>
#include "esp_transport.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef enum socks_version_t {SOCKS4 = 4} socks_version_t;
typedef enum socks_transport_response_t {
// The following values correspond to transport operation
SOCKS_RESPONSE_TARGET_NOT_FOUND = 0xF0,
SOCKS_RESPONSE_PROXY_UNREACHABLE = 0xF1,
SOCKS_TIMEOUT = 0xF2,
// The following values are defined by the SOCKS4 protocol
SOCKS_RESPONSE_SUCCESS = 0x5a,
SOCKS_RESPONSE_REQUEST_REJECTED = 0x5B,
SOCKS_RESPONSE_NOT_RUNNING_IDENTD = 0x5c,
SOCKS_RESPONSE_COULD_NOT_CONFIRM_ID = 0x5d,
} socks_transport_error_t;
/*
* Socks configuration structure
*/
typedef struct esp_transport_socks_proxy_config_t {
const socks_version_t version; /*!< Socks protocol version.*/
const char *address;/*!< Proxy address*/
const int port; /*< Proxy port*/
} esp_transport_socks_proxy_config_t;
/**
* @brief Create a proxy transport
* @param parent_handle Handle for the parent transport
* @param config Pointer to the configuration structure to use
*
* @return
* - transport Handler for the created transport.
* - NULL in case of failure
*/
esp_transport_handle_t esp_transport_socks_proxy_init(esp_transport_handle_t parent_handle, const esp_transport_socks_proxy_config_t *config);
/**
* @brief Changes the configuration of the proxy
* @param socks_transport Handle for the transport
* @param config Pointer to the configuration structure to use
*
* @return
* - ESP_OK on success
*/
esp_err_t esp_transport_socks_proxy_set_config(esp_transport_handle_t socks_transport, const esp_transport_socks_proxy_config_t *config);
#ifdef __cplusplus
}
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.