chore(doc): Documentation, examples & tests for protocol.rs

Co-authored-by: Paul Spooren <[email protected]>
cyberstormdotmu · Dec 16, 2024 · 46e855b · 46e855b
1 parent c0b91fd
commit 46e855b
Show file tree

Hide file tree

Showing 3 changed files with 2,275 additions and 111 deletions.
diff --git a/rosenpass/src/protocol/mod.rs b/rosenpass/src/protocol/mod.rs
@@ -16,7 +16,11 @@
 //! # Example Handshake
 //!
 //! This example illustrates a minimal setup for a key-exchange between two
-//! [CryptoServer].
+//! [CryptoServer]s; this is what we use for some testing purposes but it is not
+//! what should be used in a real world application, as timing-based events
+//! are handled by [CryptoServer::poll].
+//!
+//! See [CryptoServer::poll] on how to use crypto server in polling mode for production usage.
 //!
 //! ```
 //! use std::ops::DerefMut;