Roxen.git / server / modules / examples / common_api.pike

version» Context lines:

Roxen.git/server/modules/examples/common_api.pike:1:   inherit "module";   // All roxen modules must inherit module.pike    - constant cvs_version = "$Id: common_api.pike,v 1.2 2000/08/24 10:56:10 jhs Exp $"; + constant cvs_version = "$Id: common_api.pike,v 1.3 2000/08/25 17:44:18 jhs Exp $";   //! This string (filtered to remove some ugly cvs id markup) shows up in   //! the roxen administration interface when handling module parameters in   //! developer mode (configured under "User Settings" below the Admin tab).   //! It will also serve as the basis for extracting version information of   //! the file in the inherit tree. Optional, but convenient, especially if   //! you use cvs for version control of your code.      constant module_name = "Tamaroxchi";   //! The name that will show up in the module listings when adding modules   //! or viewing the modules of a virtual server. Keep it fairly informative
Roxen.git/server/modules/examples/common_api.pike:50:   void create(Configuration|void conf)   //! In <pi>create()</pi>, you typically define your module's   //! configurable variables (using <ref>defvar()</ref>) and set data   //! about it using <ref>set_module_creator()</ref> and   //! <ref>set_module_url()</ref>. The configuration object of the   //! virtual server the module was initialized in is always passed,   //! except for the one occation when the file is compiled for the   //! first time, when the `conf' argument passed is 0. Se also   //! <ref>start</ref>.   { -  report_debug("tamagotchi(%O)\n", conf); // Ends up in the debug log +  //report_debug("tamaroxchi(%O)\n", conf); // Ends up in the debug log    set_module_creator("Johan Sundström <jhs@roxen.com>");    set_module_url("https://jhs.user.roxen.com/examples/common_api.html");   }      mapping(string:function(RequestID:void)) query_action_buttons( RequestID id )   //! Optional callback for adding action buttons to the module's   //! administration settings page; convenient for triggering module   //! actions like flushing caches and the like.   //!   //! The indices of the returned mapping are the action descriptions that will