Struct Server 

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

Controller and completion future for a running server.

Clones can pause, resume, stop, or submit items to the server. Awaiting a Server resolves when the server has stopped. It always resolves to Ok(()).

Implementations

impl Server<Connection>

pub fn builder() -> ServerBuilder

Creates a network server builder with no application configuration.

impl<T> Server<T>

pub fn metrics(&self) -> ServerMetrics

Returns a snapshot of the server metrics.

pub fn process(&self, item: T) -> Result<(), T>

Submits an item to the worker pool.

The worker is chosen on the calling thread, see LoadBalancing.

Returns the item unchanged if the server status is not Ready or the server cannot accept it, so items submitted right after start or while no worker is available are rejected.

pub fn status(&self) -> ServerStatus

Returns the current server status.

pub fn status_changed(&self) -> impl Future<Output = ServerStatus> + use<T>

Waits for the server status to change and returns the new status.

The status is compared with the status at the time of this call, so changes made before the future is polled are not missed. Changes in quick succession may be reported once, with the latest status.

Resolves immediately with Stopped if the server has stopped.

pub fn pause(&self) -> impl Future<Output = ()> + use<T>

Pauses processing new items.

For network servers, listeners stop accepting connections, so new connections wait in the kernel listen backlog. Existing connections remain active.

The server stays Paused until resume is called.

pub fn resume(&self) -> impl Future<Output = ()> + use<T>

Resumes processing new items.

The server becomes Ready once a worker is available.

pub fn stop(&self, graceful: bool) -> impl Future<Output = ()> + use<T>

Stops processing new items and shuts down all workers.

If graceful is true, workers are given up to the graceful shutdown timeout to finish active work before they are stopped. A zero timeout makes the stop non-graceful.

The returned future resolves once the stop has completed. If the server has already stopped, it resolves immediately.

Trait Implementations

impl<T> Clone for Server<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 Server<T>

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

Formats the value using the given formatter.

impl<T> Future for Server<T>

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.