Struct Worker 

pub struct Worker<T> { /* private fields */ }

Server worker.

A worker runs one service instance on its own arbiter thread. It receives items through an unbounded channel. Clones refer to the same worker.

Implementations

impl<T> Worker<T>

pub fn start<F>(name: String, cfg: F, cpu: Option<usize>) -> Worker<T>

where T: Send + 'static, F: ServerConfiguration<Item = T>,

Starts a worker on a new arbiter thread.

Returns immediately. The worker reports Unavailable until its service is created. If cpu is set, the worker thread is pinned to the logical CPU with that index. On Windows, CPUs are numbered across processor groups, the CPUs of group 1 follow the CPUs of group 0. Pinning is supported on Windows, Linux and Android.

pub fn name(&self) -> &str

Returns the worker name.

pub fn send(&self, msg: T) -> Result<(), T>

Sends a message to the worker.

Returns Ok if the message was queued. The message is queued even if the worker is currently unavailable. Returns the message as Err if the worker has stopped.

pub fn status(&self) -> WorkerStatus

Returns the current worker status.

pub async fn wait_for_status(&mut self) -> WorkerStatus

Waits for a status change not yet reported by this handle and returns the current status.

Each handle tracks the changes it has reported, so every clone observes every change. A clone starts with the reported changes of the handle it was cloned from. Several changes between calls are reported once. Returns immediately if the worker has failed.

pub fn stop(&self, timeout: Millis) -> WorkerStop

Stops the worker.

The worker stops accepting items and shuts down its service, waiting up to timeout. A zero timeout uses the default of 3 seconds.

Trait Implementations

impl<T> Clone for Worker<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Worker<T>

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

Formats the value using the given formatter.

impl<T> Eq for Worker<T>

impl<T> Hash for Worker<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Worker<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T> PartialEq for Worker<T>

fn eq(&self, other: &Worker<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> PartialOrd for Worker<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.