Struct Job

pub struct Job<TKey, TMsg>
where
    TKey: JobKey,
    TMsg: Message,
{
    pub key: TKey,
    pub msg: TMsg,
    pub options: JobOptions,
    pub accepted: Option<RpcReplyPort<Option<Self>>>,
}

Represents a job sent to a factory

Depending on the super::Factory’s routing scheme the Job’s key is utilized to dispatch the job to specific workers.

Fields

key: TKey

The key of the job

msg: TMsg

The message of the job

options: JobOptions

The job’s options, mainly related to timing information of the job

Default = JobOptions::default()

accepted: Option<RpcReplyPort<Option<Self>>>

If provided, this channel can be used to block pushes into the factory until the factory can “accept” the message into its internal processing. This can be used to synchronize external threadpools to the Tokio processing pool and prevent overloading the unbounded channel which fronts all actors.

The reply channel return None if the job was accepted, or [Some(Job)] if it was rejected & loadshed, and then the job may be retried by the caller at a later time (if desired).

Default = None

Implementations

impl<TKey, TMsg> Job<TKey, TMsg>

where TKey: JobKey, TMsg: Message,

pub fn builder() -> JobBuilder<TKey, TMsg>

Create an instance of Job using the builder syntax

impl<TKey, TMsg> Job<TKey, TMsg>

where TKey: JobKey, TMsg: Message,

pub fn is_expired(&self) -> bool

Determine if this job’s TTL is expired

Expiration only takes effect prior to the job being started execution on a worker.

Trait Implementations

impl<TKey, TMsg> Debug for Job<TKey, TMsg>

where TKey: JobKey, TMsg: Message,

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

Formats the value using the given formatter.