croczilla.com 
 home   zap   svg   xtf   jssh   bits&pieces   blog   personal   
  home > zap > code docs

Zap Code Documentation

Overview

The Zap sourcecode is split into the following modules (all residing under mozilla/zap/):

  • base: Common shared (mostly JS) utility code.

  • netutils: Support for STUN and DNS (SRV/NAPTR queries)

  • zmk: "Zap Media Kit" Media processing library.

  • sdp: Session Description Protocol parser/negotiator and media session logic.

  • sip: Implementation of the Session Initiation Protocol. Further split into submodules:
    • syntax layer
    • transport layer
    • transaction layer
    • UA layer
  • client: Zap user agent application chrome

There are also several patches for other areas of Mozilla that Zap depends on, including:

  • mozilla/netwerk/base/{public,src}: Necko UDP socket support (see bug191187).
  • mozilla/js/src/xpconnect/: A JS code-sharing library (see bug238324).
  • mozilla/js/src/xpconnect/: JS weak reference support (see bug317304).
  • mozilla/js/src/xpconnect/: JS getObjectId() support (see bug317485).

See also the zap tracker bug, bug317491.

For a full list of modified and new files see ZAP_BRANCH_MODIFIED_FILES and ZAP_BRANCH_NEW_FILES in mozilla/client.mk on the zap branch.

Finally, the zap branch also contains the JSSh code (under mozilla/extensions/jssh). This comes in very handy for interactive development.

Detailed documentation

Doxygen-generated docs

Note: Not all modules have doxygen documentation yet.

Docutils System Messages

System Message: INFO/1 (<string>, line 37)

Hyperlink target "portaudio" is not referenced.

System Message: INFO/1 (<string>, line 42)

Hyperlink target "bug16773" is not referenced.

System Message: INFO/1 (<string>, line 43)

Hyperlink target "bug29474" is not referenced.