diff --git a/API.md b/API.md index d6e6c9d9f..867ce5cac 100644 --- a/API.md +++ b/API.md @@ -1,6 +1,10 @@ ## Xous Messaging API In Practice +All Messages passed between Xous Servers undergo serialization and de-serialization. +- Internal `struct` are readily serialized with [rkyv](https://docs.rs/rkyv/0.4.3/rkyv/) and `#[derive(Debug, num_derive::FromPrimitive, num_derive::ToPrimitive)]`with manual serialization as an alternative ([example](services/net/src/std_udp.rs)) +- External `struct` may employ [bincode](https://docs.rs/bincode/latest/bincode/) + Here are the idioms for building servers and passing messages. ### api.rs diff --git a/apps/repl/README.md b/apps/repl/README.md index fdc2d4007..3e62ef973 100644 --- a/apps/repl/README.md +++ b/apps/repl/README.md @@ -20,6 +20,9 @@ It implements the basic envisioned structure of a Xous application, namely: - Text input comes via the `ime-frontend` - Graphical output is rendered via the `gam` +[Push Events and Listeners](../../wiki/Push-Events-and-Listeners) provides an overview of the flow of +messages between an Xous application and the Xous Services. + The one demo command provisioned in the `repl` app plays a tone via the `codec` service. This was chosen because it is about one of the most complicated and comprehensive things you can do in the `repl` environment, as it requires