From 5ac7bd8b23cac06f73ee0194b4c629d1b398dbc4 Mon Sep 17 00:00:00 2001 From: nworbnhoj Date: Wed, 6 Apr 2022 06:42:01 +1000 Subject: [PATCH 1/3] Link repl readme to wiki Push Events and Listeners --- apps/repl/README.md | 3 +++ 1 file changed, 3 insertions(+) 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 From 5b0ecb6d274777154a63461019374c742df54f9e Mon Sep 17 00:00:00 2001 From: nworbnhoj Date: Wed, 6 Apr 2022 07:26:40 +1000 Subject: [PATCH 2/3] link to rkyv & bincode in API.md --- API.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/API.md b/API.md index d6e6c9d9f..556080415 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.7.37/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 From d862e25a559d57ada9bae59a14c84d58a36c441e Mon Sep 17 00:00:00 2001 From: nworbnhoj Date: Wed, 6 Apr 2022 21:48:20 +1000 Subject: [PATCH 3/3] Correct rkyv link to v0.4.3 in API.md --- API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API.md b/API.md index 556080415..867ce5cac 100644 --- a/API.md +++ b/API.md @@ -2,7 +2,7 @@ ## 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.7.37/rkyv/) and `#[derive(Debug, num_derive::FromPrimitive, num_derive::ToPrimitive)]`with manual serialization as an alternative ([example](services/net/src/std_udp.rs)) +- 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.