http_client.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2019 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_HTTP_CLIENT_H_
#define ZEPHYR_INCLUDE_NET_HTTP_CLIENT_H_
 
#include <zephyr/kernel.h>
#include <zephyr/net/net_ip.h>
#include <zephyr/net/http_parser.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !defined(HTTP_CRLF)
#define HTTP_CRLF "\r\n"
#endif
 
#if !defined(HTTP_STATUS_STR_SIZE)
#define HTTP_STATUS_STR_SIZE    32
#endif
 
/* Is there more data to come */
enum http_final_call {
        HTTP_DATA_MORE = 0,
        HTTP_DATA_FINAL = 1,
};
 
struct http_request;
struct http_response;
 
typedef int (*http_payload_cb_t)(int sock,
                                 struct http_request *req,
                                 void *user_data);
 
typedef int (*http_header_cb_t)(int sock,
                                struct http_request *req,
                                void *user_data);
 
typedef void (*http_response_cb_t)(struct http_response *rsp,
                                   enum http_final_call final_data,
                                   void *user_data);
 
struct http_response {
        const struct http_parser_settings *http_cb;
 
        http_response_cb_t cb;
 
        uint8_t *body_frag_start;
 
        size_t body_frag_len;
 
        uint8_t *recv_buf;
 
        size_t recv_buf_len;
 
        size_t data_len;
 
        size_t content_length;
 
        size_t processed;
 
        /* https://tools.ietf.org/html/rfc7230#section-3.1.2
         * The status-code element is a 3-digit integer code
         *
         * The reason-phrase element exists for the sole
         * purpose of providing a textual description
         * associated with the numeric status code. A client
         * SHOULD ignore the reason-phrase content.
         *
         * Will be blank if a null HTTP response is given.
         */
        char http_status[HTTP_STATUS_STR_SIZE];
 
        uint16_t http_status_code;
 
        uint8_t cl_present : 1;
        uint8_t body_found : 1;
        uint8_t message_complete : 1;
};
 
struct http_client_internal_data {
        struct k_work_delayable work;
 
        struct http_parser parser;
 
        struct http_parser_settings parser_settings;
 
        struct http_response response;
 
        void *user_data;
 
        int sock;
 
        k_timeout_t timeout;
};
 
struct http_request {
        struct http_client_internal_data internal;
 
        /* User should fill in following parameters */
 
        enum http_method method;
 
        http_response_cb_t response;
 
        const struct http_parser_settings *http_cb;
 
        uint8_t *recv_buf;
 
        size_t recv_buf_len;
 
        const char *url;
 
        const char *protocol;
 
        const char **header_fields;
 
        const char *content_type_value;
 
        const char *host;
 
        const char *port;
 
        http_payload_cb_t payload_cb;
 
        const char *payload;
 
        size_t payload_len;
 
        http_header_cb_t optional_headers_cb;
 
        const char **optional_headers;
};
 
int http_client_req(int sock, struct http_request *req,
                    int32_t timeout, void *user_data);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_HTTP_CLIENT_H_ */