Roxen.git
/
server
/
modules
/
examples
/
common_api.pike
version
»
Context lines:
10
20
40
80
file
none
3
Roxen.git/server/modules/examples/common_api.pike:1:
-
// This is a
roxen
module. Copyright © 2000 - 2001, Roxen IS.
+
// This is a
ChiliMoon
module. Copyright © 2000 - 2001, Roxen IS.
inherit "module"; // All roxen modules must inherit module.pike
-
constant cvs_version="$Id: common_api.pike,v 1.
10
2002
/06/
14
10
:
34
:
58
nilsson
Exp $";
+
constant cvs_version="$Id: common_api.pike,v 1.
11
2004
/06/
05
15
:
19
:
44
_cvs_dirix
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:29:
"module to your virtual server, promise!"); //! The documentation string that will end up in the administration //! interface view of the module just below the module name. Also shows //! up in the more verbose add module views. constant module_unique = 1; //! 0 to allow multiple instances of the module per virtual server, //! 1 to allow at most one. constant thread_safe = 0;
-
//! Tell
Roxen
that this module is thread safe. That is, there is no
+
//! Tell
ChiliMoon
that this module is thread safe. That is, there is no
//! request specific data in module global variables (such state is //! better put in the <ref>RequestID</ref> object, preferably in the //! <pi>id->misc</pi> mapping under some key unique to your module). //! //! If your module is not thread safe, setting this flag to zero (0) or //! leaving it unset altogether will make roxen serialize accesses to //! your module. This will hurt performance on a busy server. A value of //! one (1) means your module is thread safe. int itching = 0;
Roxen.git/server/modules/examples/common_api.pike:88:
itching = 0; report_notice("Aah, that's good.\n"); } else report_warning("Ouch!\n"); } string info( Configuration conf ) //! Implementing this function in your module is optional. //! //! When present, it returns a string that describes the module.
-
//! When absent,
Roxen
will use element <ref>module_doc</ref>. Unlike
+
//! When absent,
Chilimoon
will use element <ref>module_doc</ref>. Unlike
//! module_doc, though, this information is only shown when the module //! is present in a virtual server, so it won't show up when adding //! modules to a server. { string mp = query_internal_location(); return sprintf("This string overrides the documentation string " "given in module_doc, but only once the " "module is added to a server. The module's internal " "mountpoint is found at <tt>%s</tt>", mp );