Enum glean_core::upload::PingUploadTask

pub enum PingUploadTask {
    Upload {
        request: PingRequest,
    },
    Wait {
        time: u64,
    },
    Done { /* private fields */ },
}

An enum representing the possible upload tasks to be performed by an uploader.

When asking for the next ping request to upload, the requester may receive one out of three possible tasks.

If new variants are added, this should be reflected in glean-core/ffi/src/upload.rs as well.

Variants

Upload

Fields

request: PingRequest

The ping request for upload See PingRequest for more information.

An upload task

Wait

Fields

time: u64

The time in milliseconds the requester should wait before requesting a new task.

A flag signaling that the pending pings directories are not done being processed, thus the requester should wait and come back later.

Done

Fields

A flag signaling that requester doesn’t need to request any more upload tasks at this moment.

There are three possibilities for this scenario:

• Pending pings queue is empty, no more pings to request;
• Requester has gotten more than MAX_WAIT_ATTEMPTS (3, by default) PingUploadTask::Wait responses in a row;
• Requester has reported more than MAX_RECOVERABLE_FAILURES_PER_UPLOADING_WINDOW recoverable upload failures on the same uploading window (see below) and should stop requesting at this moment.

An “uploading window” starts when a requester gets a new PingUploadTask::Upload(PingRequest) response and finishes when they finally get a PingUploadTask::Done or PingUploadTask::Wait response.

Implementations

impl PingUploadTask

pub fn is_upload(&self) -> bool

Whether the current task is an upload task.

pub fn is_wait(&self) -> bool

Whether the current task is wait task.

Trait Implementations

impl Debug for PingUploadTask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<PingUploadTask> for PingUploadTask

fn eq(&self, other: &PingUploadTask) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PingUploadTask) -> bool

This method tests for !=.

impl StructuralPartialEq for PingUploadTask