esp_http_client_port.c File Reference

#include "../vsf_espidf_cfg.h"
#include "esp_http_client.h"
#include "esp_err.h"
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <errno.h>
#include "service/heap/vsf_heap.h"
#include "utilities/vsf_utilities.h"
#include <unistd.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>
#include <fcntl.h>
#include "component/tcpip/protocol/http/client/vsf_http_client.h"
#include "component/3rd-party/mbedtls/extension/tls_session/mbedtls_tls_session.h"

Data Structures
struct	http_parser_url
struct	vsf_ehc_header_t
struct	vsf_ehc_tcp_state_t
struct	esp_http_client

Macros
#define	__VSF_HTTP_CLIENT_CLASS_INHERIT__
#define	VSF_ESPIDF_HTTP_CLIENT_CFG_MAX_REDIRECT_DEFAULT   10
#define	VSF_ESPIDF_HTTP_CLIENT_CFG_MAX_AUTH_RETRIES_DEFAULT   10
#define	VSF_EHC_DEFAULT_TIMEOUT_MS   5000
#define	VSF_EHC_DEFAULT_HTTP_PORT   80
#define	VSF_EHC_DEFAULT_HTTPS_PORT   443

Typedefs
typedef struct vsf_ehc_header_t	vsf_ehc_header_t
typedef struct vsf_ehc_tcp_state_t	vsf_ehc_tcp_state_t

Enumerations
enum	http_parser_url_fields {   UF_SCHEMA = 0 ,   UF_HOST = 1 ,   UF_PORT = 2 ,   UF_PATH = 3 ,   UF_QUERY = 4 ,   UF_FRAGMENT = 5 ,   UF_USERINFO = 6 ,   UF_MAX = 7 }

Functions
esp_http_client_handle_t	esp_http_client_init (const esp_http_client_config_t *config)
esp_err_t	esp_http_client_cleanup (esp_http_client_handle_t client)
esp_err_t	esp_http_client_close (esp_http_client_handle_t client)
esp_err_t	esp_http_client_open (esp_http_client_handle_t client, int write_len)
int	esp_http_client_write (esp_http_client_handle_t client, const char *buffer, int len)
int64_t	esp_http_client_fetch_headers (esp_http_client_handle_t client)
int	esp_http_client_read (esp_http_client_handle_t client, char *buffer, int len)
int	esp_http_client_read_response (esp_http_client_handle_t client, char *buffer, int len)
bool	esp_http_client_is_complete_data_received (esp_http_client_handle_t client)
bool	esp_http_client_is_chunked_response (esp_http_client_handle_t client)
esp_err_t	esp_http_client_perform (esp_http_client_handle_t client)
esp_err_t	esp_http_client_set_url (esp_http_client_handle_t client, const char *url)
esp_err_t	esp_http_client_get_url (esp_http_client_handle_t client, char *url, const int len)
esp_err_t	esp_http_client_set_method (esp_http_client_handle_t client, esp_http_client_method_t method)
esp_err_t	esp_http_client_set_header (esp_http_client_handle_t client, const char *key, const char *value)
esp_err_t	esp_http_client_get_header (esp_http_client_handle_t client, const char *key, char **value)
esp_err_t	esp_http_client_delete_header (esp_http_client_handle_t client, const char *key)
esp_err_t	esp_http_client_delete_all_headers (esp_http_client_handle_t client)
esp_err_t	esp_http_client_get_response_header (esp_http_client_handle_t client, const char *key, char **value)
esp_err_t	esp_http_client_set_post_field (esp_http_client_handle_t client, const char *data, int len)
int	esp_http_client_get_post_field (esp_http_client_handle_t client, char **data)
esp_err_t	esp_http_client_set_timeout_ms (esp_http_client_handle_t client, int timeout_ms)
esp_err_t	esp_http_client_set_user_data (esp_http_client_handle_t client, void *data)
esp_err_t	esp_http_client_get_user_data (esp_http_client_handle_t client, void **data)
esp_err_t	esp_http_client_set_username (esp_http_client_handle_t client, const char *username)
esp_err_t	esp_http_client_get_username (esp_http_client_handle_t client, char **value)
esp_err_t	esp_http_client_set_password (esp_http_client_handle_t client, const char *password)
esp_err_t	esp_http_client_get_password (esp_http_client_handle_t client, char **value)
esp_err_t	esp_http_client_set_authtype (esp_http_client_handle_t client, esp_http_client_auth_type_t auth_type)
esp_err_t	esp_http_client_add_auth (esp_http_client_handle_t client)
esp_err_t	esp_http_client_set_auth_data (esp_http_client_handle_t client, const char *auth_data, int len)
esp_err_t	esp_http_client_set_redirection (esp_http_client_handle_t client)
esp_err_t	esp_http_client_reset_redirect_counter (esp_http_client_handle_t client)
esp_err_t	esp_http_client_cancel_request (esp_http_client_handle_t client)
int	esp_http_client_get_status_code (esp_http_client_handle_t client)
int64_t	esp_http_client_get_content_length (esp_http_client_handle_t client)
int64_t	esp_http_client_get_content_range (esp_http_client_handle_t client)
esp_http_client_transport_t	esp_http_client_get_transport_type (esp_http_client_handle_t client)
esp_http_state_t	esp_http_client_get_state (esp_http_client_handle_t client)
int	esp_http_client_get_socket (esp_http_client_handle_t client)
int	esp_http_client_get_errno (esp_http_client_handle_t client)
esp_err_t	esp_http_client_get_chunk_length (esp_http_client_handle_t client, int *len)
bool	esp_http_client_is_persistent_connection (esp_http_client_handle_t client)
esp_err_t	esp_http_client_get_and_clear_last_tls_error (esp_http_client_handle_t client, int *esp_tls_error_code, int *esp_tls_flags)
esp_err_t	esp_http_client_prepare (esp_http_client_handle_t client)
esp_err_t	esp_http_client_request_send (esp_http_client_handle_t client, int write_len)
int	esp_http_client_chunk_write_begin (esp_http_client_handle_t client, const int len)
int	esp_http_client_chunk_write_end (esp_http_client_handle_t client, bool last_chunk)
esp_err_t	esp_http_client_flush_response (esp_http_client_handle_t client, int *len)
esp_err_t	esp_http_client_clear_response_buffer (esp_http_client_handle_t client)

Macro Definition Documentation

__VSF_HTTP_CLIENT_CLASS_INHERIT__

#define __VSF_HTTP_CLIENT_CLASS_INHERIT__

VSF_ESPIDF_HTTP_CLIENT_CFG_MAX_REDIRECT_DEFAULT

#define VSF_ESPIDF_HTTP_CLIENT_CFG_MAX_REDIRECT_DEFAULT   10

VSF_ESPIDF_HTTP_CLIENT_CFG_MAX_AUTH_RETRIES_DEFAULT

#define VSF_ESPIDF_HTTP_CLIENT_CFG_MAX_AUTH_RETRIES_DEFAULT   10

VSF_EHC_DEFAULT_TIMEOUT_MS

#define VSF_EHC_DEFAULT_TIMEOUT_MS   5000

VSF_EHC_DEFAULT_HTTP_PORT

#define VSF_EHC_DEFAULT_HTTP_PORT   80

VSF_EHC_DEFAULT_HTTPS_PORT

#define VSF_EHC_DEFAULT_HTTPS_PORT   443

Typedef Documentation

vsf_ehc_header_t

typedef struct vsf_ehc_header_t vsf_ehc_header_t

vsf_ehc_tcp_state_t

typedef struct vsf_ehc_tcp_state_t vsf_ehc_tcp_state_t

Enumeration Type Documentation

http_parser_url_fields

enum http_parser_url_fields

Enumerator
UF_SCHEMA
UF_HOST
UF_PORT
UF_PATH
UF_QUERY
UF_FRAGMENT
UF_USERINFO
UF_MAX

Function Documentation

esp_http_client_init()

esp_http_client_handle_t esp_http_client_init

(

const esp_http_client_config_t *

config

)

esp_http_client_cleanup()

esp_err_t esp_http_client_cleanup

(

esp_http_client_handle_t

client

)

esp_http_client_close()

esp_err_t esp_http_client_close

(

esp_http_client_handle_t

client

)

esp_http_client_open()

esp_err_t esp_http_client_open	(	esp_http_client_handle_t	client,
		int	write_len
	)

esp_http_client_write()

int esp_http_client_write	(	esp_http_client_handle_t	client,
		const char *	buffer,
		int	len
	)

esp_http_client_fetch_headers()

int64_t esp_http_client_fetch_headers

(

esp_http_client_handle_t

client

)

esp_http_client_read()

int esp_http_client_read	(	esp_http_client_handle_t	client,
		char *	buffer,
		int	len
	)

esp_http_client_read_response()

int esp_http_client_read_response	(	esp_http_client_handle_t	client,
		char *	buffer,
		int	len
	)

esp_http_client_is_complete_data_received()

bool esp_http_client_is_complete_data_received

(

esp_http_client_handle_t

client

)

esp_http_client_is_chunked_response()

bool esp_http_client_is_chunked_response

(

esp_http_client_handle_t

client

)

esp_http_client_perform()

esp_err_t esp_http_client_perform

(

esp_http_client_handle_t

client

)

esp_http_client_set_url()

esp_err_t esp_http_client_set_url	(	esp_http_client_handle_t	client,
		const char *	url
	)

esp_http_client_get_url()

esp_err_t esp_http_client_get_url	(	esp_http_client_handle_t	client,
		char *	url,
		const int	len
	)

esp_http_client_set_method()

esp_err_t esp_http_client_set_method	(	esp_http_client_handle_t	client,
		esp_http_client_method_t	method
	)

esp_http_client_set_header()

esp_err_t esp_http_client_set_header	(	esp_http_client_handle_t	client,
		const char *	key,
		const char *	value
	)

esp_http_client_get_header()

esp_err_t esp_http_client_get_header	(	esp_http_client_handle_t	client,
		const char *	key,
		char **	value
	)

esp_http_client_delete_header()

esp_err_t esp_http_client_delete_header	(	esp_http_client_handle_t	client,
		const char *	key
	)

esp_http_client_delete_all_headers()

esp_err_t esp_http_client_delete_all_headers

(

esp_http_client_handle_t

client

)

esp_http_client_get_response_header()

esp_err_t esp_http_client_get_response_header	(	esp_http_client_handle_t	client,
		const char *	key,
		char **	value
	)

esp_http_client_set_post_field()

esp_err_t esp_http_client_set_post_field	(	esp_http_client_handle_t	client,
		const char *	data,
		int	len
	)

esp_http_client_get_post_field()

int esp_http_client_get_post_field	(	esp_http_client_handle_t	client,
		char **	data
	)

esp_http_client_set_timeout_ms()

esp_err_t esp_http_client_set_timeout_ms	(	esp_http_client_handle_t	client,
		int	timeout_ms
	)

esp_http_client_set_user_data()

esp_err_t esp_http_client_set_user_data	(	esp_http_client_handle_t	client,
		void *	data
	)

esp_http_client_get_user_data()

esp_err_t esp_http_client_get_user_data	(	esp_http_client_handle_t	client,
		void **	data
	)

esp_http_client_set_username()

esp_err_t esp_http_client_set_username	(	esp_http_client_handle_t	client,
		const char *	username
	)

esp_http_client_get_username()

esp_err_t esp_http_client_get_username	(	esp_http_client_handle_t	client,
		char **	value
	)

esp_http_client_set_password()

esp_err_t esp_http_client_set_password	(	esp_http_client_handle_t	client,
		const char *	password
	)

esp_http_client_get_password()

esp_err_t esp_http_client_get_password	(	esp_http_client_handle_t	client,
		char **	value
	)

esp_http_client_set_authtype()

esp_err_t esp_http_client_set_authtype	(	esp_http_client_handle_t	client,
		esp_http_client_auth_type_t	auth_type
	)

esp_http_client_add_auth()

esp_err_t esp_http_client_add_auth

(

esp_http_client_handle_t

client

)

esp_http_client_set_auth_data()

esp_err_t esp_http_client_set_auth_data	(	esp_http_client_handle_t	client,
		const char *	auth_data,
		int	len
	)

esp_http_client_set_redirection()

esp_err_t esp_http_client_set_redirection

(

esp_http_client_handle_t

client

)

esp_http_client_reset_redirect_counter()

esp_err_t esp_http_client_reset_redirect_counter

(

esp_http_client_handle_t

client

)

esp_http_client_cancel_request()

esp_err_t esp_http_client_cancel_request

(

esp_http_client_handle_t

client

)

esp_http_client_get_status_code()

int esp_http_client_get_status_code

(

esp_http_client_handle_t

client

)

esp_http_client_get_content_length()

int64_t esp_http_client_get_content_length

(

esp_http_client_handle_t

client

)

esp_http_client_get_content_range()

int64_t esp_http_client_get_content_range

(

esp_http_client_handle_t

client

)

esp_http_client_get_transport_type()

esp_http_client_transport_t esp_http_client_get_transport_type

(

esp_http_client_handle_t

client

)

esp_http_client_get_state()

esp_http_state_t esp_http_client_get_state

(

esp_http_client_handle_t

client

)

esp_http_client_get_socket()

int esp_http_client_get_socket

(

esp_http_client_handle_t

client

)

esp_http_client_get_errno()

int esp_http_client_get_errno

(

esp_http_client_handle_t

client

)

esp_http_client_get_chunk_length()

esp_err_t esp_http_client_get_chunk_length	(	esp_http_client_handle_t	client,
		int *	len
	)

esp_http_client_is_persistent_connection()

bool esp_http_client_is_persistent_connection

(

esp_http_client_handle_t

client

)

esp_http_client_get_and_clear_last_tls_error()

esp_err_t esp_http_client_get_and_clear_last_tls_error	(	esp_http_client_handle_t	client,
		int *	esp_tls_error_code,
		int *	esp_tls_flags
	)

esp_http_client_prepare()

esp_err_t esp_http_client_prepare

(

esp_http_client_handle_t

client

)

esp_http_client_request_send()

esp_err_t esp_http_client_request_send	(	esp_http_client_handle_t	client,
		int	write_len
	)

esp_http_client_chunk_write_begin()

int esp_http_client_chunk_write_begin	(	esp_http_client_handle_t	client,
		const int	len
	)

esp_http_client_chunk_write_end()

int esp_http_client_chunk_write_end	(	esp_http_client_handle_t	client,
		bool	last_chunk
	)

esp_http_client_flush_response()

esp_err_t esp_http_client_flush_response	(	esp_http_client_handle_t	client,
		int *	len
	)

esp_http_client_clear_response_buffer()

esp_err_t esp_http_client_clear_response_buffer

(

esp_http_client_handle_t

client

)