Add server diagrams

solana-labs · Jun 7, 2018 · 586279b · 586279b
1 parent 8bd10e7
commit 586279b
Showing 1 changed file with 49 additions and 0 deletions.
diff --git a/src/server.rs b/src/server.rs
@@ -20,6 +20,30 @@ pub struct Server {
 }
 
 impl Server {
+    /// Create a server instance acting as leader.
+    ///
+    /// ```text
+    ///              .---------------------.
+    ///              |  Leader             |
+    ///              |                     |
+    ///  .--------.  |  .-----.            |
+    ///  |        |---->|     |            |
+    ///  | Client |  |  | RPU |            |
+    ///  |        |<----|     |            |
+    ///  `----+---`  |  `-----`            |
+    ///       |      |     ^               |
+    ///       |      |     |               |
+    ///       |      |  .--+---.           |
+    ///       |      |  | Bank |           |
+    ///       |      |  `------`           |
+    ///       |      |     ^               |
+    ///       |      |     |               |    .------------.
+    ///       |      |  .--+--.   .-----.  |    |            |
+    ///       `-------->| TPU +-->| NCP +------>| Validators |
+    ///              |  `-----`   `-----`  |    |            |
+    ///              |                     |    `------------`
+    ///              `---------------------`
+    /// ```
     pub fn new_leader<W: Write + Send + 'static>(
         bank: Bank,
         tick_duration: Option<Duration>,
@@ -72,6 +96,31 @@ impl Server {
 
         Server { thread_hdls }
     }
+
+    /// Create a server instance acting as validator.
+    ///
+    /// ```text
+    ///               .-------------------------------.
+    ///               |            Validator          |
+    ///               |                               |
+    ///   .--------.  |            .-----.            |
+    ///   |        |-------------->|     |            |
+    ///   | Client |  |            | RPU |            |
+    ///   |        |<--------------|     |            |
+    ///   `--------`  |            `-----`            |
+    ///               |               ^               |
+    ///               |               |               |
+    ///               |            .--+---.           |
+    ///               |            | Bank |           |
+    ///               |            `------`           |
+    ///               |               ^               |
+    ///    .--------. |               |               |    .------------.
+    ///    |        | |  .-----.   .--+--.   .-----.  |    |            |
+    ///    | Leader |----| NCP +-->| TVU +-->| NCP +------>| Validators |
+    ///    |        | |  `-----`   `-----`   `-----`  |    |            |
+    ///    `--------` |                               |    `------------`
+    ///               `-------------------------------`
+    /// ```
     pub fn new_validator(
         bank: Bank,
         me: ReplicatedData,