Struct WorkQueue 

pub struct WorkQueue<M>
where
    M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,
{ /* private fields */ }

Implementations

impl<M> WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

pub fn new(job_name: String, backend: Arc<dyn Backend>) -> WorkQueue<M>

pub fn queue_name(&self) -> &str

Get the queue name (used as prefix for all queue keys)

pub fn start_with_name( name: String, backend: Arc<dyn Backend + Send + Sync>, ) -> ActorRef<WorkQueue<M>>

pub fn run_with_config( &self, job: Job<M>, config: EnqueueConfig, ) -> Result<(), Error>

pub fn enqueue(&self, job: Job<M>) -> Result<(), Error>

pub fn re_enqueue(&self, job: Job<M>) -> Result<(), Error>

pub fn mark_job_is_canceled(&self, job_id: &str)

pub fn mark_job_is_finished(&self, job: Job<M>) -> Result<(), Error>

pub fn mark_job_is_failed(&self, job: Job<M>) -> Result<(), Error>

pub fn process_jobs(&self)

pub fn pick_jobs_to_process(&self) -> Result<Vec<Job<M>>, Error>

pub fn execute_job_task(&self, job: Job<M>)

pub async fn execute_job(&self, job: Job<M>) -> Result<(), Error>

pub fn cancel_job(&self, job_id: &str) -> Result<(), Error>

pub fn get_job(&self, job_id: &str) -> Result<Option<Job<M>>, Error>

pub fn retry_job(&self, job_id: &str) -> Result<bool, Error>

pub fn read_job(&self, job_id: &str) -> Result<Option<Job<M>>, Error>

pub fn get_processing_job_ids( &self, _count: usize, ) -> Result<Vec<String>, Error>

Trait Implementations

impl<M> Actor for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Mailbox = UnboundedMailbox<WorkQueue<M>>

The mailbox type used for the actor.

fn name() -> &'static str

The name of the actor, which can be useful for logging or debugging.

fn new_mailbox() -> (<WorkQueue<M> as Actor>::Mailbox, <<WorkQueue<M> as Actor>::Mailbox as Mailbox<WorkQueue<M>>>::Receiver)

Creates a new mailbox for the actor. This sets up the message queue and receiver for the actor.

fn on_start( &mut self, actor_ref: ActorRef<Self>, ) -> impl Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send

Called when the actor starts, before it processes any messages.

fn on_panic( &mut self, actor_ref: WeakActorRef<Self>, err: PanicError, ) -> impl Future<Output = Result<Option<ActorStopReason>, Box<dyn Error + Send + Sync>>> + Send

Called when the actor encounters a panic or an error during “tell” message handling.

fn on_link_died( &mut self, actor_ref: WeakActorRef<Self>, id: ActorID, reason: ActorStopReason, ) -> impl Future<Output = Result<Option<ActorStopReason>, Box<dyn Error + Send + Sync>>> + Send

Called when a linked actor dies.

fn on_stop( &mut self, actor_ref: WeakActorRef<Self>, reason: ActorStopReason, ) -> impl Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send

Called before the actor stops.

impl<M> Clone for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

fn clone(&self) -> WorkQueue<M>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M> Message<CancelJob> for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Reply = Result<(), Error>

The reply sent back to the message caller.

async fn handle( &mut self, msg: CancelJob, _ctx: Context<'_, WorkQueue<M>, <WorkQueue<M> as Message<CancelJob>>::Reply>, ) -> <WorkQueue<M> as Message<CancelJob>>::Reply

Handler for this message.

impl<M> Message<Enqueue<M>> for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Reply = Result<(), Error>

The reply sent back to the message caller.

async fn handle( &mut self, msg: Enqueue<M>, _ctx: Context<'_, WorkQueue<M>, <WorkQueue<M> as Message<Enqueue<M>>>::Reply>, ) -> <WorkQueue<M> as Message<Enqueue<M>>>::Reply

Handler for this message.

impl<M> Message<GetJob<M>> for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Reply = Option<Job<M>>

The reply sent back to the message caller.

async fn handle( &mut self, msg: GetJob<M>, _ctx: Context<'_, WorkQueue<M>, <WorkQueue<M> as Message<GetJob<M>>>::Reply>, ) -> <WorkQueue<M> as Message<GetJob<M>>>::Reply

Handler for this message.

impl<M> Message<ProcessTick> for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Reply = ()

The reply sent back to the message caller.

async fn handle( &mut self, _msg: ProcessTick, _ctx: Context<'_, WorkQueue<M>, <WorkQueue<M> as Message<ProcessTick>>::Reply>, ) -> <WorkQueue<M> as Message<ProcessTick>>::Reply

Handler for this message.

impl<M> Message<RetryJob<M>> for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Reply = Result<bool, Error>

The reply sent back to the message caller.

async fn handle( &mut self, msg: RetryJob<M>, _ctx: Context<'_, WorkQueue<M>, <WorkQueue<M> as Message<RetryJob<M>>>::Reply>, ) -> <WorkQueue<M> as Message<RetryJob<M>>>::Reply

Handler for this message.

impl<M> Message<UpdateWorkQueue> for WorkQueue<M>

where M: Executable + Send + Sync + Clone + Serialize + DeserializeOwned + 'static,

type Reply = ()

The reply sent back to the message caller.

async fn handle( &mut self, msg: UpdateWorkQueue, _ctx: Context<'_, WorkQueue<M>, <WorkQueue<M> as Message<UpdateWorkQueue>>::Reply>, ) -> <WorkQueue<M> as Message<UpdateWorkQueue>>::Reply

Handler for this message.