tree: 5943e631077aaf429202f767aa3965997e5b90a7 [path history] [tgz]
  1. CONTROL_FLOW.md
  2. CORE_BINDINGS.md
  3. DETAILS.md
  4. HACKING.md
  5. IMPROVEMENTS.md
  6. IP_TYPES.md
  7. PARSING_SERIALIZATION.md
  8. PUB_CRATE.md
  9. README.md
  10. STATIC_TYPING.md
src/connectivity/network/netstack3/docs/README.md

Docs

This directory contains documentation of various aspects of the netstack. Briefly:

  • CONTROL_FLOW.md describes and motivates how our control flow works
  • CORE_BINDINGS.md describes and motivates the split of our codebase into two separate “core” and “bindings” components
  • DETAILS.md describes various implementation details that are confusing enough to be worth calling out explicitly
  • HACKING.md contains instructions for hacking on the netstack
  • IMPROVEMENTS.md contains ideas for possible future improvements
  • IP_TYPES.md describes our use of types and traits to represent IP versions and addresses
  • PARSING_SERIALIZATION.md describes how we parse and serialize packets, and how we manage packet buffers
  • PUB_CRATE.md describes how we use visibility modifiers.
  • STATIC_TYPING.md motivates our enthusiastic use of static typing