Structures and Enumerations

General Description

HTTP Client library data structures and type definitions.

Data Structures
struct	cy_http_client_header_t
	HTTP structure containing the HTTP header fields. More...
struct	cy_http_client_request_header_t
	HTTP structure containing the fields required for the request header. More...
struct	cy_http_client_response_t
	HTTP structure containing the fields required for response header and body. More...

Typedefs
typedef void *	cy_http_client_t
	HTTP Client handle.
typedef void(*	cy_http_disconnect_callback_t) (cy_http_client_t handle, cy_http_client_disconn_type_t type, void *user_data)
	Disconnect notification callback function which was registered while invoking /ref cy_http_client_create. More...

Enumerations
enum	cy_http_client_method_t {   CY_HTTP_CLIENT_METHOD_GET ,   CY_HTTP_CLIENT_METHOD_PUT ,   CY_HTTP_CLIENT_METHOD_POST ,   CY_HTTP_CLIENT_METHOD_HEAD ,   CY_HTTP_CLIENT_METHOD_DELETE ,   CY_HTTP_CLIENT_METHOD_PATCH ,   CY_HTTP_CLIENT_METHOD_CONNECT ,   CY_HTTP_CLIENT_METHOD_OPTIONS ,   CY_HTTP_CLIENT_METHOD_TRACE }
	HTTP Client supported methods. More...
enum	cy_http_client_disconn_type_t {   CY_HTTP_CLIENT_DISCONN_TYPE_SERVER_INITIATED = 0 ,   CY_HTTP_CLIENT_DISCONN_TYPE_NETWORK_DOWN = 1 }
	HTTP Client disconnect type. More...

Typedef Documentation

cy_http_disconnect_callback_t

typedef void(* cy_http_disconnect_callback_t) (cy_http_client_t handle, cy_http_client_disconn_type_t type, void *user_data)

Disconnect notification callback function which was registered while invoking /ref cy_http_client_create.

On disconnect event, the application needs to call cy_http_client_disconnect() to disconnect.

Parameters

handle	[in] : Handle for which disconnection has occurred.
type	[in] : Disconnect type.
user_data	[in] : User data provided by the caller while invoking /ref cy_http_client_create.

Returns

: void

Enumeration Type Documentation

cy_http_client_method_t

enum cy_http_client_method_t

HTTP Client supported methods.

Enumerator
CY_HTTP_CLIENT_METHOD_GET	HTTP GET Method
CY_HTTP_CLIENT_METHOD_PUT	HTTP PUT Method
CY_HTTP_CLIENT_METHOD_POST	HTTP POST Method
CY_HTTP_CLIENT_METHOD_HEAD	HTTP HEAD Method
CY_HTTP_CLIENT_METHOD_DELETE	HTTP DELETE Method
CY_HTTP_CLIENT_METHOD_PATCH	HTTP PATCH Method
CY_HTTP_CLIENT_METHOD_CONNECT	HTTP CONNECT Method.
CY_HTTP_CLIENT_METHOD_OPTIONS	HTTP OPTIONS Method.
CY_HTTP_CLIENT_METHOD_TRACE	HTTP TRACE Method

cy_http_client_disconn_type_t

enum cy_http_client_disconn_type_t

HTTP Client disconnect type.

Enumerator
CY_HTTP_CLIENT_DISCONN_TYPE_SERVER_INITIATED	Server initiated disconnect.
CY_HTTP_CLIENT_DISCONN_TYPE_NETWORK_DOWN	Network is disconnected.