pub struct JobQueue(pub Arc<dyn StorageBackend>);Expand description
Actix Web request extractor for enqueueing background jobs from HTTP handlers.
§Examples
use actix_web::{post, web, App, HttpResponse, HttpServer, Responder};
use azums_actix::{BackgroundJobs, JobQueue};
use serde_json::json;
#[post("/orders")]
async fn create_order(queue: JobQueue) -> impl Responder {
let job_id = queue
.enqueue_now("default", "process_order", json!({"item": "book"}))
.await
.unwrap();
HttpResponse::Ok().json(json!({ "status": "queued", "id": job_id }))
}Tuple Fields§
§0: Arc<dyn StorageBackend>Implementations§
Source§impl JobQueue
impl JobQueue
Sourcepub fn new(backend: Arc<dyn StorageBackend>) -> Self
pub fn new(backend: Arc<dyn StorageBackend>) -> Self
Creates a JobQueue wrapping a StorageBackend.
Sourcepub fn backend(&self) -> &Arc<dyn StorageBackend> ⓘ
pub fn backend(&self) -> &Arc<dyn StorageBackend> ⓘ
Returns reference to the underlying StorageBackend.
Sourcepub async fn enqueue_now(
&self,
queue: &str,
job_type: &str,
payload_json: Value,
) -> Result<Uuid>
pub async fn enqueue_now( &self, queue: &str, job_type: &str, payload_json: Value, ) -> Result<Uuid>
Enqueues a job immediately with default queue "default", priority 0, and 25 max attempts.
Trait Implementations§
Source§impl FromRequest for JobQueue
impl FromRequest for JobQueue
Auto Trait Implementations§
impl !RefUnwindSafe for JobQueue
impl !UnwindSafe for JobQueue
impl Freeze for JobQueue
impl Send for JobQueue
impl Sync for JobQueue
impl Unpin for JobQueue
impl UnsafeUnpin for JobQueue
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more