devspec.en_US/4.3.=module-interface.md

   1 \r
   2 \r
   3 # introduction\r
   4 ==============\r
   5 \r
   6 \r
   7 \r
   8 # interface type\r
   9 ================\r
  10 \r
  11 @ executable symbol. normally function, variable is the element of interface.    and typedef, macro, const is also for some language.\r
  12 @ command option. it's the human user-end operation interface.\r
  13 @ communication protocol. it's the interface between different programs or \r
  14   devices.\r
  15 @ file format. it's the same as protocal. it include two type of format, text \r
  16   format and hex format.\r
  17 @ file/device.\r
  18 @ shared memory.\r
  19 @ variables. environment variables, or dvar.\r
  20 @ db table.\r
  21 @ message/databus-id.\r
  22 @ IPCSyncObj.\r
  23 @ UIElem(elem & grid & position)\r
  24 \r
  25     for a module of codelib, it's only have symbol interface. those ware the\r
  26 standard component for developping.\r
  27 \r
  28     prefix:\r
  29 @ g: for global things in a executable.\r
  30 @ sys: for the system things.\r
  31 @ if/itf/intf: for interface of a modulized codelib.\r
  32 \r
  33 \r
  34 \r
  35 # performence\r
  36 \r
  37 @ binary-size: size of totoal, bss, data, and code.\r
  38 @ exec-time-cost: running time cost.\r
  39 @ performence eval point: function or variable access filter. evaluate the \r
  40   invoking count and frequent.\r
  41 @ running-coverage-diagram.\r
  42 @ function-invoking-diagram.\r
  43 \r
  44 \r
  45 \r