Skip to content

Examples: alternative roadmaps? #275

Description

@liyishuai

Thank you for the nice examples!
I wonder if an alternative roadmap of presenting the examples might help the readers better apply this framework to their projects:

Current roadmap:

  1. In-process echo
  2. In-process echo + callback
  3. Network echo + callback + network server in the same program
  4. Network echo + callback + network server in different programs

Suppose I want "Basic echo + network server in different programs", I should first learn from (1) about how to write a .capnp file, and then go directly to (4), and strip away the callback and heartbeat parts.

I doubt if anyone would want to run a network server and a client in the same process, so (3) doesn't seem informative.

Does it make sense to roadmap as follows?

  1. Syntax: How to write a basic .capnp file, and validate its functionality in an in-process echo example? (above 1)
  2. Network: How to split the echo into different programs? (above 4 minus 2)
  3. Semantics: How to make the protocol more interesting? (above 2)

Now the user may try any path: either (i) 1 -> 1+2 -> 1+2+3; or (ii) 1 -> 1+3 -> 1+3+2.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions