Struct drmem_api::driver::RequestChan

pub struct RequestChan { /* private fields */ }

A handle which is used to communicate with the core of DrMem. When a driver is created, it will be given a handle to be used throughout its life.

This type wraps the mpsc::Sender<> and defines a set of helper methods to send requests and receive replies with the core.

Implementations

impl RequestChan

pub fn new(driver_name: &str, prefix: &Path, req_chan: &Sender<Request>) -> Self

pub async fn add_ro_device(
    &self,
    name: Base,
    units: Option<&str>,
    max_history: Option<usize>
) -> Result<(ReportReading, Option<Value>)>

Registers a read-only device with the framework. name is the last section of the full device name. Typically a driver will register several devices, each representing a portion of the hardware being controlled. All devices for a given driver instance will have the same prefix; the name parameter is appended to it.

If it returns Ok(), the value is a broadcast channel that the driver uses to announce new values of the associated hardware.

If it returns Err(), the underlying value could be InUse, meaning the device name is already registered. If the error is InternalError, then the core has exited and the RequestChan has been closed. Since the driver can’t report any more updates, it may as well shutdown.

pub async fn add_rw_device(
    &self,
    name: Base,
    units: Option<&str>,
    max_history: Option<usize>
) -> Result<(ReportReading, RxDeviceSetting, Option<Value>)>

Registers a read-write device with the framework. name is the last section of the full device name. Typically a driver will register several devices, each representing a portion of the hardware being controlled. All devices for a given driver instance will have the same prefix; the name parameter is appended to it.

If it returns Ok(), the value is a pair containing a broadcast channel that the driver uses to announce new values of the associated hardware and a receive channel for incoming settings to be applied to the hardware.

If it returns Err(), the underlying value could be InUse, meaning the device name is already registered. If the error is InternalError, then the core has exited and the RequestChan has been closed. Since the driver can’t report any more updates or accept new settings, it may as well shutdown.

Trait Implementations

impl Clone for RequestChan

fn clone(&self) -> RequestChan

Returns a copy of the value.

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

Performs copy-assignment from source.