Struct ImageRequestQueue

pub struct ImageRequestQueue {
    inner: Arc<Mutex<ImageRequestQueueInner>>,
}

A queue for image requests.

This implements the following features:

• Limit the number of concurrent requests,
• Prioritize requests according to their importance,
• Avoid duplicate requests,
• Watch requests that fail with I/O errors to:
  • Reinsert them at the end of the queue to retry them later,
  • Reduce the pool capacity temporarily to avoid more similar errors and let the system recover.
• Watch requests that take too long to:
  • Log them,
  • Ignore them in the count of ongoing requests.

Fields

inner: Arc<Mutex<ImageRequestQueueInner>>

Implementations

impl ImageRequestQueue

fn new() -> Self

Construct an empty ImageRequestQueue with the default settings.

pub async fn add_download_request( &self, client: Client, settings: MediaRequestParameters, dimensions: Option<FrameDimensions>, priority: ImageRequestPriority, ) -> ImageRequestHandle

Add a request to download an image.

If another request for the same image already exists, this will reuse the same request.

pub async fn add_file_request( &self, file: File, dimensions: Option<FrameDimensions>, ) -> ImageRequestHandle

Add a request to load an image from a file.

If another request for the same file already exists, this will reuse the same request.

async fn mark_as_stalled(&self, request_id: ImageRequestId)

Mark the request with the given ID as stalled.

async fn retry_request(&self, request_id: &ImageRequestId, lower_limit: bool)

Retry the request with the given ID.

If lower_limit is true, we will also lower the limit of the queue.

async fn remove_request(&self, request_id: &ImageRequestId)

Remove the request with the given ID.