Struct apalis::redis::RedisConsumer

pub struct RedisConsumer<J> where
    J: 'static + Job + JobHandler<RedisConsumer<J>>,  { /* fields omitted */ }

Implementations

impl<J> RedisConsumer<J> where
    J: Job + JobHandler<RedisConsumer<J>>, 

pub fn new(queue: &Queue<J, RedisStorage>) -> RedisConsumer<J>

pub fn id(&self) -> &String

pub fn data<D>(self, data: D) -> RedisConsumer<J> where
    D: Any + Send + Sync, 

pub fn create(url: &str) -> Result<RedisConsumer<J>, RedisError>

pub fn build_producer(&self) -> Addr<RedisProducer<J>>

Trait Implementations

impl<J> Actor for RedisConsumer<J> where
    J: 'static + JobHandler<RedisConsumer<J>> + Job, 

type Context = Context<RedisConsumer<J>>

Actor execution context type

pub fn started(&mut self, ctx: &mut Context<RedisConsumer<J>>)

Called when an actor gets polled the first time.

fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Called after an actor is in Actor::Stopping state.

fn stopped(&mut self, ctx: &mut Self::Context)

Called after an actor is stopped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor, returning its address.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Construct and start a new asynchronous actor, returning its address.

fn start_in_arbiter<F>(arb: &Arbiter, f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self + Send + 'static, 

Start new actor in arbiter’s thread.

fn create<F>(f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self, 

Start a new asynchronous actor given a Context.

impl<J> Clone for RedisConsumer<J> where
    J: 'static + Clone + Job + JobHandler<RedisConsumer<J>>, 

pub fn clone(&self) -> RedisConsumer<J>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<J> Handler<AckJob> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

Implementation of Actix Handler for Get message.

type Result = Pin<Box<dyn Future<Output = Result<Option<bool>, Error>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    msg: AckJob,
    &mut <RedisConsumer<J> as Actor>::Context
) -> <RedisConsumer<J> as Handler<AckJob>>::Result

This method is called for every message received by this actor.

impl<J> Handler<RegisterConsumer> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

type Result = Pin<Box<dyn Future<Output = Result<Option<bool>, Error>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    _msg: RegisterConsumer,
    &mut <RedisConsumer<J> as Actor>::Context
) -> <RedisConsumer<J> as Handler<RegisterConsumer>>::Result

This method is called for every message received by this actor.

impl<J> Handler<RetryJob> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

Implementation of Actix Handler for retrying jobs

type Result = Pin<Box<dyn Future<Output = Result<Option<i8>, Error>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    msg: RetryJob,
    &mut <RedisConsumer<J> as Actor>::Context
) -> <RedisConsumer<J> as Handler<RetryJob>>::Result

This method is called for every message received by this actor.

impl<J> Handler<Stop> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

type Result = ()

The type of value that this handler will return.

pub fn handle(
    &mut self,
    Stop,
    ctx: &mut <RedisConsumer<J> as Actor>::Context
) -> <RedisConsumer<J> as Handler<Stop>>::Result

This method is called for every message received by this actor.

impl<J> StreamHandler<FetchJob> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Send + Job, 

Implementation of Actix Handler fetching jobs.

pub fn handle(
    &mut self,
    _msg: FetchJob,
    ctx: &mut <RedisConsumer<J> as Actor>::Context
)

Method is called for every message received by this Actor

fn started(&mut self, ctx: &mut Self::Context)

Method is called when stream get polled first time.

fn finished(&mut self, ctx: &mut Self::Context)

Method is called when stream finishes.

fn add_stream<S>(fut: S, ctx: &mut Self::Context) -> SpawnHandle where
    S: Stream<Item = I> + 'static,
    I: 'static,
    Self::Context: AsyncContext<Self>, 

This method register stream to an actor context and allows to handle Stream in similar way as normal actor messages.

impl<J> StreamHandler<HeartBeat> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

pub fn handle(&mut self, HeartBeat, &mut Context<RedisConsumer<J>>)

Method is called for every message received by this Actor

pub fn finished(&mut self, &mut <RedisConsumer<J> as Actor>::Context)

Method is called when stream finishes.

fn started(&mut self, ctx: &mut Self::Context)

Method is called when stream get polled first time.

fn add_stream<S>(fut: S, ctx: &mut Self::Context) -> SpawnHandle where
    S: Stream<Item = I> + 'static,
    I: 'static,
    Self::Context: AsyncContext<Self>, 

This method register stream to an actor context and allows to handle Stream in similar way as normal actor messages.

impl<J> StreamHandler<Schedule> for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

pub fn handle(&mut self, Schedule, ctx: &mut Context<RedisConsumer<J>>)

Method is called for every message received by this Actor

pub fn finished(&mut self, &mut <RedisConsumer<J> as Actor>::Context)

Method is called when stream finishes.

fn started(&mut self, ctx: &mut Self::Context)

Method is called when stream get polled first time.

fn add_stream<S>(fut: S, ctx: &mut Self::Context) -> SpawnHandle where
    S: Stream<Item = I> + 'static,
    I: 'static,
    Self::Context: AsyncContext<Self>, 

This method register stream to an actor context and allows to handle Stream in similar way as normal actor messages.

impl<J> Supervised for RedisConsumer<J> where
    J: 'static + Unpin + JobHandler<RedisConsumer<J>> + Job, 

pub fn restarting(&mut self, &mut Context<RedisConsumer<J>>)

Called when the supervisor restarts a failed actor.

impl<J> Consumer for RedisConsumer<J> where
    J: 'static + JobHandler<RedisConsumer<J>> + Job,