plugins/README

   1 Monkey Plugins
   2 ==============
   3 Plugins are extra features which modifies the Monkey behavior, all of them
   4 are shared libraries which are loaded on runtime.
   5
   6 Each plugin is loaded per configuration instruction and it will work on a
   7 defined stage or event depending of it's type.
   8
   9 Please review the file API.txt for more details
  10
  11
  12
  13 MK_PLUGIN_STAGE_10: Server has not yet entered in the server loop, no
  14                     listeners yet available
  15 ---------------------------------------------------------------------
  16   Return Values >
  17
  18
  19 MK_PLUGIN_STAGE_20: Accepted connection has not been assigned to worker thread
  20 ------------------------------------------------------------------------------
  21    Return Values >
  22
  23                   * MK_PLUGIN_RET_CLOSE_CONX: The connection must be closed.
  24
  25
  26 MK_PLUGIN_STAGE_30: HTTP Request received
  27 -----------------------------------------
  28    Return Values >
  29                   * MK_PLUGIN_RET_CLOSE_CONX: The connection must be closed.
  30
  31
  32 MK_PLUGIN_STAGE_40: Object Handler
  33 -----------------------------------------
  34    Extra functions >
  35                   * _mk_plugin_stage_40_loop(): if _mk_plugin_stage_40() has
  36                     returned MK_PLUGIN_RET_CONTINUE, the server will wait
  37                     for an event and call _mk_plugin_stage_40() until it
  38                     returns MK_PLUGIN_RET_END.
  39
  40                     Return Values >
  41                                 * MK_PLUGIN_RET_END
  42                                 * MK_PLUGIN_RET_CONTINUE
  43
  44    Return Values >
  45                   * MK_PLUGIN_RET_NOT_ME: Plugin will not handle this request.
  46
  47                   * MK_PLUGIN_RET_END: Plugin has taken some action and
  48                     has finished the work, the handler will no take the request
  49                     again.
  50
  51                   * MK_PLUGIN_RET_CONTINUE:: Plugin has taken some action and
  52                     will continue in the next loop.
  53
  54
  55 MK_PLUGIN_STAGE_50: Request ended
  56 -----------------------------------------
  57
  58
  59 MK_PLUGIN_STAGE_60: The Connection has been closed
  60 --------------------------------------------------
  61