HTTP Client Middleware Library
cy_http_client_request_header_t Struct Reference

Description

HTTP structure containing the fields required for the request header.

Data Fields

cy_http_client_method_t method
 Method for which the HTTP Client request has to be sent.
 
const char * resource_path
 Path to which HTTP Client request has to be sent; NULL terminated.
 
uint8_t * buffer
 Pointer to the buffer to store HTTP request and the HTTP response received from the server. More...
 
size_t buffer_len
 Length of the buffer in bytes.
 
size_t headers_len
 Length of the request header updated in cy_http_client_write_header, or the user has to update this field if the header is generated by the application and passed to cy_http_client_send.
 
int32_t range_start
 Indicates the Start Range from where the server should return. More...
 
int32_t range_end
 Indicates the End Range until where the data is expected. More...
 

Field Documentation

◆ buffer

uint8_t* cy_http_client_request_header_t::buffer

Pointer to the buffer to store HTTP request and the HTTP response received from the server.

This buffer needs to be allocated by the caller and should not be freed before cy_http_client_send returns.

◆ range_start

int32_t cy_http_client_request_header_t::range_start

Indicates the Start Range from where the server should return.

If the range header is not required, set this value to -1.

◆ range_end

int32_t cy_http_client_request_header_t::range_end

Indicates the End Range until where the data is expected.

Set this to -1 if requested range is all bytes from the starting range byte to the end of file or the requested range is for the last N bytes of the file.