download_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef DOWNLOAD_CLIENT_H__
#define DOWNLOAD_CLIENT_H__
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/net/coap.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define K_THREAD_STACK_MEMBER K_KERNEL_STACK_MEMBER
 
enum download_client_evt_id {
        DOWNLOAD_CLIENT_EVT_FRAGMENT,
        DOWNLOAD_CLIENT_EVT_ERROR,
        DOWNLOAD_CLIENT_EVT_DONE,
        DOWNLOAD_CLIENT_EVT_CLOSED,
};
 
struct download_fragment {
        const void *buf;
        size_t len;
};
 
struct download_client_evt {
        enum download_client_evt_id id;
 
        union {
                int error;
                struct download_fragment fragment;
        };
};
 
struct download_client_cfg {
        const int *sec_tag_list;
        uint8_t sec_tag_count;
        uint8_t pdn_id;
        int family;
        size_t frag_size_override;
        bool set_tls_hostname;
};
 
typedef int (*download_client_callback_t)(
        const struct download_client_evt *event);
 
struct download_client {
        struct k_mutex mutex;
 
        int fd;
 
        struct sockaddr remote_addr;
 
        char buf[CONFIG_DOWNLOAD_CLIENT_BUF_SIZE];
        size_t offset;
 
        size_t file_size;
        size_t progress;
 
        const char *host;
        const char *file;
        struct download_client_cfg config;
 
        int proto;
 
        struct  {
                bool has_header;
                bool connection_close;
                bool ranged;
        } http;
 
        struct {
                struct coap_block_context block_ctx;
 
                struct coap_pending pending;
        } coap;
 
        k_tid_t tid;
        struct k_thread thread;
        struct k_sem wait_for_download;
 
        /* Internal thread stack. */
        K_THREAD_STACK_MEMBER(thread_stack,
                              CONFIG_DOWNLOAD_CLIENT_STACK_SIZE);
 
        download_client_callback_t callback;
 
        bool set_native_tls;
 
        bool close_when_done;
 
        enum {
                DOWNLOAD_CLIENT_IDLE,
                DOWNLOAD_CLIENT_CONNECTING,
                DOWNLOAD_CLIENT_DOWNLOADING,
                DOWNLOAD_CLIENT_FINISHED,
                DOWNLOAD_CLIENT_CLOSING
        } state;
};
 
int download_client_init(struct download_client *client,
                         download_client_callback_t callback);
 
int download_client_set_host(struct download_client *client, const char *host,
                            const struct download_client_cfg *config);
 
int download_client_start(struct download_client *client, const char *file,
                          size_t from);
 
int download_client_file_size_get(struct download_client *client, size_t *size);
 
int download_client_downloaded_size_get(struct download_client *client, size_t *size);
 
int download_client_disconnect(struct download_client *client);
 
int download_client_get(struct download_client *client, const char *host,
                        const struct download_client_cfg *config, const char *file, size_t from);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOWNLOAD_CLIENT_H__ */