rest_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef REST_CLIENT_H__
#define REST_CLIENT_H__
 
#include <zephyr/kernel.h>
#include <zephyr/net/http/client.h>
#include <zephyr/net/http/parser.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define REST_CLIENT_SEC_TAG_NO_SEC -1
 
#define REST_CLIENT_TLS_DEFAULT_PEER_VERIFY -1
 
#define REST_CLIENT_SCKT_CONNECT -1
 
enum rest_client_http_status {
        REST_CLIENT_HTTP_STATUS_OK = 200,
        REST_CLIENT_HTTP_STATUS_BAD_REQ = 400,
        REST_CLIENT_HTTP_STATUS_UNAUTH = 401,
        REST_CLIENT_HTTP_STATUS_FORBIDDEN = 403,
        REST_CLIENT_HTTP_STATUS_NOT_FOUND = 404,
};
 
struct rest_client_req_context {
        int connect_socket;
 
        bool keep_alive;
 
        int sec_tag;
 
        int tls_peer_verify;
 
        enum http_method http_method;
 
        const char *host;
 
        uint16_t port;
 
        const char *url;
 
        const char **header_fields;
 
        const char *body;
 
        size_t body_len;
 
        int32_t timeout_ms;
 
        char *resp_buff;
 
        size_t resp_buff_len;
};
 
struct rest_client_resp_context {
        size_t total_response_len;
 
        size_t response_len;
 
        char *response;
 
        uint16_t http_status_code;
 
        char http_status_code_str[HTTP_STATUS_STR_SIZE];
 
        int used_socket_id;
 
        int used_socket_is_alive;
};
 
int rest_client_request(struct rest_client_req_context *req_ctx,
                        struct rest_client_resp_context *resp_ctx);
 
void rest_client_request_defaults_set(struct rest_client_req_context *req_ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* REST_CLIENT_H__ */