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.

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

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<UT> ConvertError<UT> for PingUploadTask

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError ) -> Result<Self>

impl Debug for PingUploadTask

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for PingUploadTask

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

impl<UT> Lift<UT> for PingUploadTask

type FfiType = <PingUploadTask as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for PingUploadTask

type LiftType = PingUploadTask

impl<UT> LiftReturn<UT> for PingUploadTask

type ReturnType = <PingUploadTask as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for PingUploadTask

type FfiType = <PingUploadTask as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for PingUploadTask

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PingUploadTask

type ReturnType = <PingUploadTask as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for PingUploadTask

const TYPE_ID_META: MetadataBuffer = _

impl Eq for PingUploadTask

impl StructuralEq for PingUploadTask

impl StructuralPartialEq for PingUploadTask