Cargo.toml
README.md
www/index.md
www/changelog.md
src/err.rs
src/lib.rs
src/server.rs
src/client.rs
src/rctx.rs
src/rctx/err.rs
src/rctx/inner.rs
src/rctx/public.rs
tests/*.rs
examples/*.rs
benches/*.rs

[package]
name = "ump"
version = "0.11.0"
authors = ["Jan Danielsson <jan.danielsson@qrnch.com>"]
edition = "2018"
license = "0BSD"
categories = [ "concurrency", "asynchronous" ]
keywords = [ "channel", "threads", "sync", "message-passing" ]
repository = "https://repos.qrnch.tech/pub/ump"
description = "Micro message passing library for threads/tasks communication."
rust-version = "1.39"

# Can't exclude "benches", because the [[bench]] section will fail.
exclude = [
  ".efiles",
  ".fossil-settings",
  ".fslckout",
  "examples",
  "rustfmt.toml",
  "www"

]

[features]
dev-docs = []

[dependencies]
parking_lot = { version = "0.12.1" }
sigq = { version = "0.13.3" }


[dev-dependencies]
criterion = { version = "0.5.1", features = ["async_tokio"] }
tokio = { version = "1.29.1", features = ["full"] }

[[bench]]
name = "add_server"
harness = false

use crate::{err::Error, rctx::InnerReplyContext, server::ServerQueueNode};

/// Representation of a clonable client object.
///
/// Each instantiation of a `Client` object is itself an isolated client with
/// regards to the server context.  By cloning a client a new independent
/// client is created.  ("Independent" here meaning that it is still tied to
/// the same server object, but the new client can be passed to a separate

    // Create a per-call reply context.
    // This context could be created when the Client object is being created
    // and stored in the context, and thus be reused for reach client call.
    // One side-effect is that some of the state semantics becomes more
    // complicated.
    // The central repo has such an implementation checked in, but it seems to
    // have some more corner cases that aren't properly handled.
    let rctx = InnerReplyContext::new();

    self
      .qpusher
      .push(ServerQueueNode {
        msg: out,
        reply: rctx.clone()
      })
      .map_err(|_| Error::ServerDisappeared)?;

    let reply = rctx.get()?;

    Ok(reply)
  }

  #[deprecated(since = "0.10.2", note = "Use req() instead.")]
  pub fn send(&self, out: S) -> Result<R, Error<E>> {
    self.req(out)
  }

  /// Same as [`Client::req()`] but for use in `async` contexts.
  pub async fn areq(&self, out: S) -> Result<R, Error<E>> {
    let rctx = InnerReplyContext::new();

    self
      .qpusher
      .push(ServerQueueNode {
        msg: out,
        reply: rctx.clone()
      })
      .map_err(|_| Error::ServerDisappeared)?;

    let result = rctx.aget().await?;

    Ok(result)
  }

  #[deprecated(since = "0.10.2", note = "Use areq() instead.")]
  pub async fn asend(&self, out: S) -> Result<R, Error<E>> {
    self.areq(out).await
  }
}

use std::fmt;



/// Module-specific error codes.
#[derive(Debug)]
pub enum Error<E> {
  /// The server object has shut down.
  ///
  /// Happens when clients:

      _ => panic!("Not an Error::App")
    }
  }
}

impl<E: fmt::Debug> std::error::Error for Error<E> {}

impl<E> From<crate::rctx::Error<E>> for Error<E> {
  fn from(err: crate::rctx::Error<E>) -> Self {
    match err {
      crate::rctx::Error::Aborted => Error::ServerDisappeared,
      crate::rctx::Error::NoReply => Error::NoReply,
      crate::rctx::Error::App(e) => Error::App(e)
    }
  }
}

impl<E: fmt::Debug> fmt::Display for Error<E> {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    match self {
      Error::ServerDisappeared => write!(f, "Server disappeared"),
      Error::ClientsDisappeared => write!(f, "Clients disappeared"),
      Error::NoReply => write!(f, "Server didn't reply"),
      Error::App(err) => write!(f, "Application error; {:?}", err)
    }
  }
}













// vim: set ft=rust et sw=2 ts=2 sts=2 cinoptions=2 tw=79 :

//! Allow a thread/task, crossing sync/async boundaries in either direction, to
//! deliver an expected piece of data to another thread/task, with
//! notification.
//!
//! These are simple channels used to deliver data from one endpoint to
//! another, where the receiver will block until data has been delivered.

mod err;
mod inner;






pub mod public;







pub(crate) use err::Error;




















pub(crate) use inner::InnerReplyContext;












































pub use public::ReplyContext;



// vim: set ft=rust et sw=2 ts=2 sts=2 cinoptions=2 tw=79 :

use std::fmt;

/// Module-specific error codes.
#[derive(Debug)]
pub enum Error<E> {
  /// The reply was aborted.
  Aborted,

  /// The public [`ReplyContext`] object is required to reply with a value.
  /// If it does not the endpoint waiting to receive a value will abort and
  /// return this error.
  NoReply,

  /// An application-specific error occurred.
  App(E)
}

impl<E: fmt::Debug> std::error::Error for Error<E> {}

impl<E: fmt::Debug> fmt::Display for Error<E> {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    match self {
      Error::Aborted => write!(f, "Aborted call"),
      Error::NoReply => write!(f, "Application failed to reply"),
      Error::App(err) => write!(f, "Application error; {:?}", err)
    }
  }
}

// vim: set ft=rust et sw=2 ts=2 sts=2 cinoptions=2 tw=79 :

use std::{
  future::Future,
  pin::Pin,
  sync::Arc,
  task::{Context, Poll, Waker}
};

use parking_lot::{Condvar, Mutex};

use crate::rctx::err::Error;

pub(crate) enum State<I, E> {
  /// (Still) in queue, waiting to be picked up by the server.
  Queued,

  /// Was picked up, but (still) waiting for a reply to arrive.
  Waiting,

  /// Have a reply, but it wasn't delivered yet.
  Item(I),

  /// The application returned an error.
  AppErr(E),

  /// Reply is being returned to caller.
  Finalized,

  /// The server never received the message; it was dropped while in the
  /// queue.  Most likely this means that the message was still in the queue
  /// when the server was dropped.
  Aborted,

  /// The message was received by the server, but its reply context was
  /// released before sending back a reply.
  NoReply
}

pub struct InnerReplyContext<I, E> {
  pub(crate) signal: Arc<Condvar>,
  pub(crate) data: Arc<Mutex<State<I, E>>>,
  pub(crate) taskwaker: Arc<Mutex<Option<Waker>>>
}

impl<I: 'static + Send, E> InnerReplyContext<I, E> {
  /// Create a new reply context in "Queued" state.
  pub(crate) fn new() -> Self {
    InnerReplyContext {
      signal: Arc::new(Condvar::new()),
      data: Arc::new(Mutex::new(State::Queued)),
      taskwaker: Arc::new(Mutex::new(None))
    }
  }

  /// Store a reply and signal the originator that a reply has arrived.
  pub fn put(&self, item: I) {
    let mut mg = self.data.lock();
    *mg = State::Item(item);
    drop(mg);

    self.signal_waiters();
  }

  /// Store an error and signal the originator that a result has arrived.
  pub fn fail(&self, err: E) {
    let mut mg = self.data.lock();
    *mg = State::AppErr(err);
    drop(mg);

    self.signal_waiters();
  }

  pub(crate) fn signal_waiters(&self) {
    let mut g = self.taskwaker.lock();
    if let Some(waker) = (*g).take() {
      waker.wake();
    }

    self.signal.notify_one();
  }

  /// Retreive reply.  If a reply has not arrived yet then enter a loop that
  /// waits for a reply to arrive.
  pub fn get(&self) -> Result<I, Error<E>> {
    let mut mg = self.data.lock();

    let ret = loop {
      match &*mg {
        State::Queued | State::Waiting => {
          // Still waiting for server to report back with data
          self.signal.wait(&mut mg);
          continue;
        }
        State::Item(_msg) => {
          // Set Finalized state and return item
          if let State::Item(msg) =
            std::mem::replace(&mut *mg, State::Finalized)
          {
            break Ok(msg);
          } else {
            // We're *really* in trouble if this happens ..
            panic!("Unexpected state; not State::Item()");
          }
        }
        State::AppErr(_err) => {
          // Set Finalized state and return error
          if let State::AppErr(err) =
            std::mem::replace(&mut *mg, State::Finalized)
          {
            break Err(Error::App(err));
          } else {
            // We're *really* in trouble if this happens ..
            panic!("Unexpected state; not State::AppErr()");
          }
        }
        State::Finalized => {
          // We're *really* in trouble if this happens at this point ..
          panic!("Unexpected state State::Finalized");
        }
        State::Aborted => {
          // Dropped while in queue
          return Err(Error::Aborted);
        }
        State::NoReply => {
          // Dropped after reply context was picked up, but before replying
          return Err(Error::NoReply);
        }
      }
    };
    drop(mg);

    ret
  }

  pub fn aget(&self) -> WaitReplyFuture<I, E> {
    WaitReplyFuture::new(self)
  }
}

impl<I, E> Clone for InnerReplyContext<I, E> {
  fn clone(&self) -> Self {
    InnerReplyContext {
      signal: Arc::clone(&self.signal),
      data: Arc::clone(&self.data),
      taskwaker: Arc::clone(&self.taskwaker)
    }
  }
}

impl<I, E> Drop for InnerReplyContext<I, E> {
  /// If the reply context never left the server queue before being destroyed
  /// it means that the server has died.  Signal this to the original caller
  /// waiting for a reply.
  fn drop(&mut self) {
    let mut do_signal: bool = false;
    let mut mg = self.data.lock();

    if let State::Queued = *mg {
      *mg = State::Aborted;
      do_signal = true;
    }
    drop(mg);
    if do_signal {
      let mut g = self.taskwaker.lock();
      if let Some(waker) = (*g).take() {
        waker.wake();
      }
      self.signal.notify_one();
    }
  }
}


pub struct WaitReplyFuture<I, E> {
  data: Arc<Mutex<State<I, E>>>,
  waker: Arc<Mutex<Option<Waker>>>
}

impl<I, E> WaitReplyFuture<I, E> {
  fn new(irctx: &InnerReplyContext<I, E>) -> Self {
    WaitReplyFuture {
      data: Arc::clone(&irctx.data),
      waker: Arc::clone(&irctx.taskwaker)
    }
  }
}

impl<I: 'static + Send, E: 'static + Send> Future for WaitReplyFuture<I, E> {
  type Output = Result<I, Error<E>>;
  fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output> {
    let mut state = self.data.lock();
    match &*state {
      State::Queued | State::Waiting => {
        let waker = ctx.waker().clone();
        let mut g = self.waker.lock();
        *g = Some(waker);
        drop(g);
        drop(state);
        Poll::Pending
      }
      State::Item(_msg) => {
        if let State::Item(msg) =
          std::mem::replace(&mut *state, State::Finalized)
        {
          Poll::Ready(Ok(msg))
        } else {
          // We're *really* in trouble if this happens ..
          panic!("Unexpected state; not State::Item()");
        }
      }
      State::AppErr(_err) => {
        if let State::AppErr(err) =
          std::mem::replace(&mut *state, State::Finalized)
        {
          Poll::Ready(Err(Error::App(err)))
        } else {
          // We're *really* in trouble if this happens ..
          panic!("Unexpected state; not State::App()");
        }
      }
      State::Finalized => {
        panic!("Unexpected state");
      }
      State::Aborted => Poll::Ready(Err(Error::Aborted)),
      State::NoReply => Poll::Ready(Err(Error::NoReply))
    }
  }
}

// vim: set ft=rust et sw=2 ts=2 sts=2 cinoptions=2 tw=79 :

use crate::{
  rctx::{inner::State, InnerReplyContext},
  Error
};

/// Context used to transmit a reply back to the originating requester.
#[cfg_attr(
  feature = "dev-docs",
  doc = r#"
# Internals
Public-facing sender part of the `ReplyContext` object.

This, as opposed to `InnerReplyContext`, is safe to pass to applications that
are meant to only be able to put a value through the `ReplyContext` channel,
but not extract the value from it.
"#
)]
pub struct ReplyContext<I, E> {
  inner: InnerReplyContext<I, E>,
  did_handover: bool
}

impl<I: 'static + Send, E> ReplyContext<I, E> {
  /// Send a reply back to originating client.
  ///
  /// # Example
  /// ```
  /// use std::thread;
  /// use ump::channel;
  ///
  /// let (server, client) = channel::<String, String, ()>();
  /// let server_thread = thread::spawn(move || {
  ///   let (data, rctx) = server.wait().unwrap();
  ///   let reply = format!("Hello, {}!", data);
  ///   rctx.reply(reply).unwrap();
  /// });
  /// let msg = String::from("Client");
  /// let reply = client.req(msg).unwrap();
  /// assert_eq!(reply, "Hello, Client!");
  /// server_thread.join().unwrap();
  /// ```
  ///
  /// # Semantics
  /// This call is safe to make after the server context has been released.
  pub fn reply(mut self, data: I) -> Result<(), Error<E>> {
    self.inner.put(data);

    self.did_handover = true;

    Ok(())
  }

  /// Return an error to originating client.
  /// This will cause the calling client to return an error.  The error passed
  /// in the `err` parameter will be wrapped in a `Error::App(err)`.
  ///
  /// # Example
  ///
  /// ```
  /// use std::thread;
  /// use ump::{channel, Error};
  ///
  /// #[derive(Debug, PartialEq)]
  /// enum MyError {
  ///   SomeError(String)
  /// }
  ///
  /// let (server, client) = channel::<String, String, MyError>();
  /// let server_thread = thread::spawn(move || {
  ///   let (_, rctx) = server.wait().unwrap();
  ///   rctx.fail(MyError::SomeError("failed".to_string())).unwrap();
  /// });
  /// let msg = String::from("Client");
  /// let reply = client.req(msg);
  /// match reply {
  ///   Err(Error::App(MyError::SomeError(s))) => {
  ///     assert_eq!(s, "failed");
  ///   }
  ///   _ => {
  ///     panic!("Unexpected return value");
  ///   }
  /// }
  /// server_thread.join().unwrap();
  /// ```
  ///
  /// # Semantics
  /// This call is safe to make after the server context has been released.
  pub fn fail(mut self, err: E) -> Result<(), Error<E>> {
    self.inner.fail(err);

    self.did_handover = true;

    Ok(())
  }
}

impl<I, E> Drop for ReplyContext<I, E> {
  /// If the reply context is dropped while still waiting for a reply then
  /// report back to the caller that it should expect no reply.
  fn drop(&mut self) {
    if !self.did_handover {
      let mut do_signal: bool = false;
      let mut mg = self.inner.data.lock();

      if let State::Waiting = *mg {
        *mg = State::NoReply;
        do_signal = true;
      }
      drop(mg);
      if do_signal {
        let mut g = self.inner.taskwaker.lock();
        if let Some(waker) = (*g).take() {
          waker.wake();
        }

        self.inner.signal.notify_one();
      }
    }
  }
}

impl<I, E> From<InnerReplyContext<I, E>> for ReplyContext<I, E> {
  /// Transform an internal reply context into a public one and change the
  /// state from Queued to Waiting to signal that the node has left the
  /// queue.
  fn from(inner: InnerReplyContext<I, E>) -> Self {
    // Switch state from "Queued" to "Waiting", to mark that the reply context
    // has been "picked up".
    let mut mg = inner.data.lock();
    match *mg {
      State::Queued => {
        *mg = State::Waiting;
        drop(mg);
      }
      _ => {
        // Should never happen
        drop(mg);
        panic!("Unexpected node state.");
      }
    }

    ReplyContext {
      inner: inner.clone(),
      did_handover: false
    }
  }
}

// vim: set ft=rust et sw=2 ts=2 sts=2 cinoptions=2 tw=79 :

use crate::rctx::{InnerReplyContext, ReplyContext};

use crate::err::Error;



pub(crate) struct ServerQueueNode<S, R, E> {
  /// Raw message being sent from the client to the server.
  pub(crate) msg: S,

  /// Keep track of data needed to share reply data.
  pub(crate) reply: InnerReplyContext<R, E>
}

/// Representation of a server object.
///
/// Each instantiation of a [`Server`] object represents an end-point which
/// will be used to receive messages from connected [`Client`](crate::Client)
/// objects.

# Change Log

## [Unreleased]

### Added

### Changed








- Include tests when publishing crate.
- Bugfix: Use `err::Error` rather than `rctx::err::Error` in rctx::public,
  giving `ReplyContext::reply()` and `ReplyContext::fail()` the correct return
  types.

### Removed




## [0.11.0] - 2023-07-29

### Changed

- Include tests when publishing crate.

- Add `send()`/`asend()` wrappers around the new `req()`/`areq()` methods with
  a deprecation notice.
- Add a `dev-docs` feature to allow internal documentation notes to be
  included in generated documentation.

### Changed

- Rename `send()`/`asend()` to `req()/`areq()`.


## [0.10.1] - 2023-07-27

### Changed

- Runtime dependencies:

# Micro-Message Passing Library

The _ump_ crate is a simple client/server message passing library for
intra-process communication.  Its primary purpose is to allow cross
async/non-async communication (for both the server and client endpoints).


## Change log

The details of changes can always be found in the timeline, but for a
high-level view of changes between released versions there's a manually
maintained [Change Log](./changelog.md).