Skip to content

Documentation notes

Rand McKinney edited this page May 9, 2014 · 5 revisions

Overview" section

Need to add brief "how" explanation to each item or a link to section that illustrates it.

Suggestions

  • Can we create a "Hello World" zone example that actually does something? Show how it provides better stack traces, etc. than non-zone version.
  • Provide a few simple examples that illustrate how using zones improves debugging.
  • Provide short examples of each zone feature, e.g:
  • Creating a zone using std constructor and curried constructor
  • Obtaining result of a zone via std way and using co-style generators.
  • Using zone.data
  • Using gates

Engineering example / LB tasks

  • Add zones to: sls-sample-app, LB scaffolding

Implementation status (monkey patches)

  • Child processes -> not done (exec, spawn, execFile)
  • Cluster -> not done
  • Crypto: pbkdf2, randomBytes, pseudoBytes
  • Domain -> unknown
  • Events -> special rules for using them across zones
  • fs -> done except fs.watch, fs.watchFile, ff.FSWatcher
  • process object -> done except process.on('SIGHUP') etc
  • require -> special rule: modules always get loaded globally
  • HTTP -> done except agent issues
  • HTTPS -> done except no TLS support
  • TLS -> not done
  • UDP -> not done
  • ZLIB -> not done

Zone implementation itself

  • Gate api might change
  • Generator/yield support not done