Enum anj_coap_downloader_status_t

Defined in File coap_downloader.h

Enum Documentation

enum anj_coap_downloader_status_t

This enum represents the possible states of a CoAP Downloader module.

Values:

enumerator ANJ_COAP_DOWNLOADER_STATUS_INITIAL

Initial state of the module after startup.

Start new download by calling anj_coap_downloader_start.

enumerator ANJ_COAP_DOWNLOADER_STATUS_STARTING: A new connection to the server is being established. The download will begin once the connection is ready.

enumerator ANJ_COAP_DOWNLOADER_STATUS_DOWNLOADING: A new chunk of data is being downloaded. This status will be reported via callback for each received packet.

enumerator ANJ_COAP_DOWNLOADER_STATUS_FINISHING: The current download attempt is being cleaned up and its connection is being closed. This status is reported through the event callback only when the whole download operation is being finalized or terminated. Suspension and retry use this state internally without reporting it.

enumerator ANJ_COAP_DOWNLOADER_STATUS_FINISHED: The download process has finished successfully. The last packet has been received and the connection has been closed.

enumerator ANJ_COAP_DOWNLOADER_STATUS_RETRYING: The download process is being restarted after a failure, according to the configured retry policy. The download after retry will start from the last successfully received block.

enumerator ANJ_COAP_DOWNLOADER_STATUS_WAITING_FOR_RETRY: The download process is waiting for a retry attempt after a failure, according to the configured retry policy.

enumerator ANJ_COAP_DOWNLOADER_STATUS_RESUMING

The download process is being resumed after being suspended.

This status indicates that the downloader is attempting to resume the download operation from the point it was suspended.

enumerator ANJ_COAP_DOWNLOADER_STATUS_FAILED

The download process has finished due to an error.

The failure may be caused by a network issue, invalid server response, or another unexpected condition. Call anj_coap_downloader_get_error to retrieve error details.

enumerator ANJ_COAP_DOWNLOADER_STATUS_SUSPENDED: The download is suspended. Its progress is retained in this downloader instance and can be continued using anj_coap_downloader_resume.