downloader.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef __DOWNLOADER_H__
#define __DOWNLOADER_H__
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/net/coap.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum downloader_evt_id {
        DOWNLOADER_EVT_FRAGMENT,
        DOWNLOADER_EVT_ERROR,
        DOWNLOADER_EVT_DONE,
        DOWNLOADER_EVT_STOPPED,
        DOWNLOADER_EVT_DEINITIALIZED,
};
 
struct downloader_fragment {
        const void *buf;
        size_t len;
};
 
struct downloader_evt {
        enum downloader_evt_id id;
 
        union {
                int error;
                struct downloader_fragment fragment;
        };
};
 
typedef int (*downloader_callback_t)(const struct downloader_evt *event);
 
struct downloader_cfg {
        downloader_callback_t callback;
        char *buf;
        size_t buf_size;
};
 
struct downloader_host_cfg {
        const int *sec_tag_list;
        uint8_t sec_tag_count;
        uint8_t pdn_id;
        size_t range_override;
        bool set_native_tls;
        bool keep_connection;
        bool cid;
        int family;
        int (*auth_cb)(int sock);
        const char *proxy_uri;
        uint8_t redirects_max;
        const char *if_name;
};
 
enum downloader_state {
        DOWNLOADER_DEINITIALIZED,
        DOWNLOADER_IDLE,
        DOWNLOADER_CONNECTING,
        DOWNLOADER_CONNECTED,
        DOWNLOADER_DOWNLOADING,
        DOWNLOADER_STOPPING,
        DOWNLOADER_DEINITIALIZING,
};
 
struct downloader {
        struct downloader_cfg cfg;
        struct downloader_host_cfg host_cfg;
        char hostname[CONFIG_DOWNLOADER_MAX_HOSTNAME_SIZE];
        char file[CONFIG_DOWNLOADER_MAX_FILENAME_SIZE];
        size_t file_size;
        size_t progress;
        size_t buf_offset;
        bool complete;
        const struct dl_transport *transport;
        uint8_t transport_internal[CONFIG_DOWNLOADER_TRANSPORT_PARAMS_SIZE];
 
        struct k_sem event_sem;
        struct k_mutex mutex;
        enum downloader_state state;
        struct k_thread thread;
        k_tid_t tid;
        K_KERNEL_STACK_MEMBER(thread_stack, CONFIG_DOWNLOADER_STACK_SIZE);
};
 
int downloader_init(struct downloader *dl, struct downloader_cfg *cfg);
 
int downloader_deinit(struct downloader *dl);
 
int downloader_get(struct downloader *dl, const struct downloader_host_cfg *host_cfg,
                   const char *url, size_t from);
 
int downloader_get_with_host_and_file(struct downloader *dl,
                                      const struct downloader_host_cfg *host_cfg,
                                      const char *host, const char *file, size_t from);
 
int downloader_cancel(struct downloader *dl);
 
int downloader_file_size_get(struct downloader *dl, size_t *size);
 
int downloader_downloaded_size_get(struct downloader *dl, size_t *size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __DOWNLOADER_H__ */