Function anjay_download_suspend

Function Documentation

void anjay_download_suspend(anjay_t *anjay, anjay_download_handle_t dl_handle)

Suspends a download identified by dl_handle. Does nothing if dl_handle does not represent a valid download handle.

The suspend operation is performed immediately and synchronously. The socket is disconnected, but the rest of the download context is kept intact. The download can be resumed by calling anjay_download_reconnect.

If the download is already suspended due to the transport being offline (see anjay_transport_set_online), no immediate action is performed, but the download is marked in such a way that it will not be automatically resumed until an explicit call to anjay_download_reconnect.

Parameters:

  • anjay – Anjay object managing the download process.

  • dl_handle – Download handle previously returned by anjay_download.