[−][src]Struct glean_core::upload::PingUploadManager
Manages the pending pings queue and directory.
Implementations
impl PingUploadManager
[src]
pub fn new<P: Into<PathBuf>>(
data_path: P,
language_binding_name: &str,
sync_scan: bool
) -> Self
[src]
data_path: P,
language_binding_name: &str,
sync_scan: bool
) -> Self
Create a new PingUploadManager.
Spawns a new thread and processes the pending pings directory, filling up the queue with whatever pings are in there.
Arguments
data_path
- Path to the pending pings directory.sync_scan
- Whether or not ping directory scanning should be synchronous.
Panics
Will panic if unable to spawn a new thread.
pub fn set_rate_limiter(&mut self, interval: u64, max_tasks: u32)
[src]
Adds rate limiting capability to this upload manager. The rate limiter
will limit the amount of calls to get_upload_task
per interval.
Setting will restart count and timer, in case there was a previous rate limiter set (e.g. if we have reached the current limit and call this function, we start counting again and the caller is allowed to asks for tasks).
Arguments
interval
- the amount of seconds in each rate limiting window.max_tasks
- the maximum amount of task requests allowed per interval.
pub fn enqueue_ping_from_file(&self, document_id: &str)
[src]
Reads a ping file, creates a PingRequest
and adds it to the queue.
Duplicate requests won't be added.
Arguments
document_id
- The UUID of the ping in question.
pub fn clear_ping_queue(&self) -> RwLockWriteGuard<VecDeque<PingRequest>>
[src]
Clears the pending pings queue, leaves the deletion-request pings.
pub fn get_upload_task(&self, log_ping: bool) -> PingUploadTask
[src]
Gets the next PingUploadTask
.
Arguments
log_ping
- Whether to log the ping before returning.
Return value
PingUploadTask
- see PingUploadTask
for more information.
pub fn process_ping_upload_response(
&self,
document_id: &str,
status: UploadResult
)
[src]
&self,
document_id: &str,
status: UploadResult
)
Processes the response from an attempt to upload a ping.
Based on the HTTP status of said response, the possible outcomes are:
-
200 - 299 Success Any status on the 2XX range is considered a succesful upload, which means the corresponding ping file can be deleted. Known 2XX status:
- 200 - OK. Request accepted into the pipeline.
-
400 - 499 Unrecoverable error Any status on the 4XX range means something our client did is not correct. It is unlikely that the client is going to recover from this by retrying, so in this case the corresponding ping file can also be deleted. Known 4XX status:
- 404 - not found - POST/PUT to an unknown namespace
- 405 - wrong request type (anything other than POST/PUT)
- 411 - missing content-length header
- 413 - request body too large Note that if we have badly-behaved clients that retry on 4XX, we should send back 202 on body/path too long).
- 414 - request path too long (See above)
-
Any other error For any other error, a warning is logged and the ping is re-enqueued. Known other errors:
- 500 - internal error
Note
The disk I/O performed by this function is not done off-thread, as it is expected to be called off-thread by the platform.
Arguments
document_id
- The UUID of the ping in question.
status
- The HTTP status of the response.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for PingUploadManager
impl Send for PingUploadManager
impl Sync for PingUploadManager
impl Unpin for PingUploadManager
impl UnwindSafe for PingUploadManager
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,