2023-08-19 21:44:27 +02:00
|
|
|
//! # MultiPlayer Code Editing
|
|
|
|
//!
|
|
|
|
//! This is the core library of the codemp project.
|
|
|
|
//!
|
|
|
|
//! ## Structure
|
|
|
|
//! The main entrypoint is the [client::Client] object, that maintains a connection and can
|
|
|
|
//! be used to join workspaces or attach to buffers.
|
|
|
|
//!
|
|
|
|
//! Some actions will return structs implementing the [Controller] trait. These can be polled
|
|
|
|
//! for new stream events, which will be returned in order. Blocking and callback variants are also
|
|
|
|
//! implemented. The [Controller] can also be used to send new events to the server.
|
|
|
|
//!
|
|
|
|
//! ## Features
|
|
|
|
//! * `proto` : include GRCP protocol definitions under [proto] (default)
|
|
|
|
//! * `global`: provide a lazy_static global INSTANCE in [instance::global]
|
|
|
|
//! * `sync` : wraps the [instance::a_sync::Instance] holder into a sync variant: [instance::sync::Instance]
|
|
|
|
//!
|
|
|
|
|
|
|
|
|
|
|
|
/// cursor related types and controller
|
2023-04-17 14:56:00 +02:00
|
|
|
pub mod cursor;
|
2023-08-19 21:44:27 +02:00
|
|
|
|
|
|
|
/// buffer operations, factory, controller and types
|
2023-07-30 17:48:55 +02:00
|
|
|
pub mod buffer;
|
2023-08-19 21:44:27 +02:00
|
|
|
|
|
|
|
/// crate error types and helpers
|
2023-08-19 04:36:59 +02:00
|
|
|
pub mod errors;
|
2023-08-19 21:44:27 +02:00
|
|
|
|
|
|
|
/// underlying client session manager
|
2023-08-16 18:58:42 +02:00
|
|
|
pub mod client;
|
2023-08-19 21:44:27 +02:00
|
|
|
|
|
|
|
/// client wrapper to handle memory persistence
|
2023-08-16 23:09:47 +02:00
|
|
|
pub mod instance;
|
|
|
|
|
2023-08-19 21:44:27 +02:00
|
|
|
/// all-in-one imports : `use codemp::prelude::*;`
|
2023-08-17 02:58:55 +02:00
|
|
|
pub mod prelude;
|
|
|
|
|
2023-08-19 21:44:27 +02:00
|
|
|
/// underlying OperationalTransform library used, re-exported
|
2023-07-02 23:59:04 +02:00
|
|
|
pub use operational_transform as ot;
|
2023-07-01 13:54:34 +02:00
|
|
|
|
2023-08-19 21:44:27 +02:00
|
|
|
pub use client::Client;
|
|
|
|
|
|
|
|
#[cfg(feature = "sync")] pub use instance::sync::Instance;
|
|
|
|
#[cfg(not(feature = "sync"))] pub use instance::a_sync::Instance;
|
|
|
|
|
|
|
|
/// protocol types and services auto-generated by grpc
|
2023-07-30 22:58:24 +02:00
|
|
|
#[cfg(feature = "proto")]
|
2023-08-16 17:08:31 +02:00
|
|
|
#[allow(non_snake_case)]
|
2023-07-30 22:58:24 +02:00
|
|
|
pub mod proto {
|
2023-08-16 17:08:31 +02:00
|
|
|
tonic::include_proto!("codemp.buffer");
|
|
|
|
tonic::include_proto!("codemp.cursor");
|
2023-07-30 22:58:24 +02:00
|
|
|
}
|
2023-07-30 17:48:55 +02:00
|
|
|
|
2023-08-17 02:58:55 +02:00
|
|
|
pub use errors::Error;
|
2023-08-19 21:44:27 +02:00
|
|
|
pub use errors::Result;
|
2023-07-30 22:58:24 +02:00
|
|
|
|
2023-08-17 04:36:59 +02:00
|
|
|
use std::sync::Arc;
|
2023-08-19 21:44:27 +02:00
|
|
|
use tokio::runtime::Runtime;
|
2023-08-17 04:36:59 +02:00
|
|
|
|
2023-07-30 22:58:24 +02:00
|
|
|
#[tonic::async_trait] // TODO move this somewhere?
|
2023-08-19 21:44:27 +02:00
|
|
|
pub(crate) trait ControllerWorker<T : Sized + Send + Sync> {
|
2023-08-16 18:58:42 +02:00
|
|
|
type Controller : Controller<T>;
|
|
|
|
type Tx;
|
|
|
|
type Rx;
|
|
|
|
|
|
|
|
fn subscribe(&self) -> Self::Controller;
|
|
|
|
async fn work(self, tx: Self::Tx, rx: Self::Rx);
|
2023-07-30 17:48:55 +02:00
|
|
|
}
|
|
|
|
|
2023-08-19 21:44:27 +02:00
|
|
|
/// async and threadsafe handle to a generic bidirectional stream
|
|
|
|
///
|
|
|
|
/// this generic trait is implemented by actors managing stream procedures.
|
|
|
|
/// events can be enqueued for dispatching without blocking ([Controller:send]), and an async blocking
|
|
|
|
/// api ([Controller::recv]) is provided to wait for server events. Additional sync blocking
|
|
|
|
/// ([Controller::blocking_recv]) and callback-based ([Controller::callback]) are implemented.
|
2023-07-30 22:58:24 +02:00
|
|
|
#[tonic::async_trait]
|
2023-08-19 21:44:27 +02:00
|
|
|
pub trait Controller<T : Sized + Send + Sync> : Sized + Send + Sync {
|
|
|
|
/// type of upstream values, used in [Self::send]
|
2023-08-16 18:58:42 +02:00
|
|
|
type Input;
|
|
|
|
|
2023-08-19 21:44:27 +02:00
|
|
|
/// enqueue a new value to be sent
|
|
|
|
fn send(&self, x: Self::Input) -> Result<()>;
|
|
|
|
|
|
|
|
/// get next value from stream, blocking until one is available
|
|
|
|
async fn recv(&self) -> Result<T>;
|
|
|
|
|
|
|
|
/// sync variant of [Self::recv], blocking invoking thread
|
|
|
|
fn blocking_recv(&self, rt: &Runtime) -> Result<T> {
|
|
|
|
rt.block_on(self.recv())
|
|
|
|
}
|
2023-08-17 04:36:59 +02:00
|
|
|
|
2023-08-19 21:44:27 +02:00
|
|
|
/// register a callback to be called for each received stream value
|
|
|
|
///
|
|
|
|
/// this will spawn a new task on given runtime invoking [Self::recv] in loop and calling given
|
|
|
|
/// callback for each received value. a stop channel should be provided, and first value sent
|
|
|
|
/// into it will stop the worker loop.
|
|
|
|
///
|
|
|
|
/// note: creating a callback handler will hold an Arc reference to the given controller,
|
|
|
|
/// preventing it from being dropped (and likely disconnecting). using the stop channel is
|
|
|
|
/// important for proper cleanup
|
2023-08-19 04:02:21 +02:00
|
|
|
fn callback<F>(
|
|
|
|
self: Arc<Self>,
|
|
|
|
rt: &tokio::runtime::Runtime,
|
|
|
|
mut stop: tokio::sync::mpsc::UnboundedReceiver<()>,
|
|
|
|
mut cb: F
|
|
|
|
) where
|
|
|
|
Self : 'static,
|
|
|
|
F : FnMut(T) + Sync + Send + 'static
|
2023-08-17 04:36:59 +02:00
|
|
|
{
|
2023-08-18 03:58:42 +02:00
|
|
|
rt.spawn(async move {
|
2023-08-19 04:02:21 +02:00
|
|
|
loop {
|
|
|
|
tokio::select! {
|
|
|
|
Ok(data) = self.recv() => cb(data),
|
|
|
|
Some(()) = stop.recv() => break,
|
|
|
|
else => break,
|
|
|
|
}
|
2023-08-17 04:36:59 +02:00
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
2023-07-30 17:48:55 +02:00
|
|
|
}
|